Runs

Update Run

post/v1/threads/{thread_id}/runs/{run_id}

Request

  • Base URL: https://api.ambient.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.ambient.xyz/v1/threads/{thread_id}/runs/{run_id}
  • Auth: none declared

Path parameters

thread_idstring required
run_idstring required

Request body

metadataobject required

Response

Successful Response

thinking_budgetinteger nullable

WARNING. DEPRECATED. Use reasoning configuration instead.

emit_usageboolean

Whether to return usage information

emit_verifiedboolean

Whether to return verification status

emit_ambient_eventsboolean

Whether to return lifecycle events

wait_for_verificationboolean nullable

Whether to wait for verification to complete before completing the request

enabled_toolsstring[] nullable

List of enabled tools. Supported tools: ['*', 'websearch', 'retrieval', 'crypto_price', 'stock_price', 'weather', 'currency_convert', 'calculator']. Use [*] to enable all tools.

force_auction_v2boolean

Force routing via the NATS-based auction v2 request router, bypassing rollout sampling.

idstring required
assistant_idstring required
cancelled_atinteger nullable
completed_atinteger nullable
created_atinteger required
expires_atinteger nullable
failed_atinteger nullable
instructionsstring nullable
max_completion_tokensinteger nullable
max_prompt_tokensinteger nullable
metadataobject nullable
modelstring nullable
objectstring
parallel_tool_callsboolean
started_atinteger nullable
status'queued' | 'in_progress' | 'completed' | 'cancelled' | 'failed' | 'expired' | 'incomplete'
thread_idstring required
temperaturenumber nullable
top_pnumber nullable

Example response

{
  "thinking_budget": 1000,
  "reasoning": {
    "effort": "medium",
    "max_tokens": 1000,
    "enabled": true
  },
  "enabled_tools": [
    "*",
    "websearch",
    "retrieval"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.