API migration

Move new agent traffic to /v1

Legacy /assistant_* routes remain mounted for compatibility, but the universal gateway is the preferred surface for new integrations.

Open API docsUse the Python SDK

Migration map

Run agents

Prefer POST /v1/agents/run over legacy assistant chat for new execution flows.

Create agents

Use POST /v1/agents/create for the control-plane definition flow.

Call models

Use POST /v1/models/completions when you need model completion rather than an agent run.

Compatibility-first sequence

  1. Inventory legacy assistant chat, list, update, and delete calls.
  2. Move execution to /v1/agents/run and keep existing auth headers.
  3. Use the SDK’s conversation_id name for continuation; some historical wire concepts still use thread_id.
  4. Verify streaming, tool calls, usage attribution, and error handling in a non-production workspace.
  5. Retire legacy calls only after client and server behavior match.

Not every legacy management endpoint has a one-for-one public SDK wrapper today. Treat the API docs and the SDK’s shipped surface as the contract, rather than assuming route parity.

Build against the preferred surface

Start buildingUnderstand the gateway