Skip to main content
Every endpoint below is generated from the live OpenAPI spec and comes with an interactive request builder. The SDK wraps these same endpoints — see Install the SDK.

Base URL

Authentication

All /v1/* endpoints require a bearer token:
Create and scope keys in Console → API Keys. Keys can reach any rig you own that has API access enabled.

Conventions

  • JSON request and response bodies, except screenshot/observe which return image bytes.
  • Sessions meter usage — always end them (POST /v1/sessions/{id}/end).
  • Rate limits apply per key; handle 429 with backoff.
Browse the full endpoint list in the Endpoints section of the sidebar — each has an interactive request builder. Start with GET /v1/rigs to list the machines your key can reach.
Prefer the Python SDK for auth, retries, and the vision/grounding helpers. Use raw REST from any other language.