Postman collection
Download a collection covering every route the platform serves, with job ids that chain between requests.
The collection covers every operation in this reference — CodeEdit, Agent, Harbor, and Sandboxes — grouped so you can find things without hunting numbered folders.
Download
| File | What it is |
|---|---|
| Collection | The requests. Import this once. |
| Dev environment | Points at sandbox-dev.turing.com. Start here. |
| Prod environment | Points at sandbox-task.turing.com. |
| Local environment | For make up on your own machine, with local dev credentials filled in. |
In Postman: Import → drop in the collection and one environment → select that environment in the picker at the top right.
First five minutes
- Paste your platform key into
SANDBOX_API_KEY. Sandbox Dev already setstenant_id/project_id. For Admin / KeyHive also setSANDBOX_ADMIN_API_KEY. Keycloak Bearer is optional. Override only if you use a different project. - Set
llm_credential_modeto match the cluster (defaultkeyhiveon hosted envs). Usegatewayonly when the cluster runs Gateway egress. - Open Start here → Quickstart and send top → bottom.
- For compute quotas (and KeyHive BYOK), set
SANDBOX_ADMIN_API_KEYand use Admin.
llm_credential_mode | LLM BYOK |
|---|---|
keyhive (default) | Admin → Quotas & credential plane → Credential plane (KeyHive) — create team / append keys. Set provider_api_key. |
gateway | Provision BYOK on LLM Gateway. Sandbox credential-plane folder asserts HTTP 410. |
Set new_tenant_id / new_project_id when changing the project you manage for
quotas. Consumer routes auto-activate new_* when they differ from
tenant_id / project_id.
Folders
| Folder | Covers |
|---|---|
| Start here | Quickstart, gateway health/docs, auth samples |
| Admin | Compute quotas; KeyHive BYOK or Gateway 410 smokes; onboard tenancy |
| Harbor | Ops, v2 (preferred), v2 deliver, v1, unversioned |
| SSE | Live Harbor/Agent job event streams (Send and Download) |
| Agent | Catalog, runs, status, events, options |
| Code Edit | Catalog + code executions |
| Sandboxes | Long-lived sandbox lifecycle |
| Cloud IDE | ide-ubuntu — session keys under KeyHive; Gateway hints under gateway mode |
| Local | Direct service ports — make up only |
Regenerating
The JSON is generated from OpenAPI (make docs). Edit
scripts/generate_postman.py, never the published files by hand.