Start a run

POST
/v1/runs
AuthorizationBearer <token>

Checked by host({authenticate}), which maps the request to a Principal or rejects it.

In: header

Header Parameters

Idempotency-Key*string

Stored atomically with the accepted user_input, bound to the tenant, the full authenticated principal (issuer, tenant, subject), the operation and the body hash. The same key, principal and body replays the same receipt and starts nothing; a different body is idempotency_key_reused (409); a different principal in the same tenant is idempotency_key_principal_mismatch (409) and never sees the other receipt.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/runs" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "agent": "string",    "input": "string"  }'
{  "thread_id": "string",  "branch_id": "string",  "run_id": "string"}
Edit on GitHub