Quickstart

This guide walks you through creating a tenant instance, waiting for it to come online, and accessing it — all from the command line.

Prerequisites

An Orquestio API key (provided by your administrator)
curl and jq installed

Export your API key so the examples below work as-is:

export ORQUESTIO_API_KEY="your-api-key-here"

1. Verify the orchestrator is up

curl https://api.orquestio.com/health

Expected response:

{ "status": "healthy" }

2. Create an instance

curl -X POST https://api.orquestio.com/instances/create \
  -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_id": "my-first-instance",
    "tenant_id": "tenant-001",
    "blueprint_name": "OpenClaw",
    "plan_id": "openclaw-basic"
  }'

The orchestrator returns immediately with the instance metadata. The actual provisioning happens asynchronously.

{
  "instance_id": "my-first-instance",
  "tenant_id": "tenant-001",
  "state": "provisioning",
  "blueprint_name": "OpenClaw"
}

3. Poll until running

Provisioning typically takes 2-3 minutes. Poll the status endpoint until the state changes to running:

while true; do
  STATUS=$(curl -s \
    -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
    https://api.orquestio.com/instances/my-first-instance/status \
    | jq -r '.state')
  echo "State: $STATUS"
  [ "$STATUS" = "running" ] && break
  sleep 10
done

4. Access your instance

Once the status is running, the response includes an access_url:

curl -s \
  -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
  https://api.orquestio.com/instances/my-first-instance/status \
  | jq '.access_url'

Open that URL in your browser to reach your OpenClaw instance.

You can also verify it programmatically via the health proxy:

curl -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
  https://api.orquestio.com/instances/my-first-instance/health

5. (Optional) Add a custom domain

To map your own domain to the instance:

Get the CNAME target from the custom domain endpoint:

curl -X POST https://api.orquestio.com/instances/my-first-instance/custom-domain \
  -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "ai.yourcompany.com"}'

The response includes a cname_target — create a CNAME record in your DNS pointing ai.yourcompany.com to that target.

Clean up

To destroy the instance and release all associated resources:

curl -X DELETE \
  -H "Authorization: Bearer $ORQUESTIO_API_KEY" \
  https://api.orquestio.com/instances/my-first-instance

Next steps

Browse the API Reference for the full endpoint catalog
Learn about Blueprints to understand deployment templates
Set up the Portal for a UI-based management experience