API reference
Stable v1 endpoint reference.
| Path | Stable since | Notes |
|---|---|---|
/health | v1 | Liveness check (no auth) |
/v1/sessions/* | v1 | All session lifecycle |
/v1/sessions/{id}/files/* | v1 | All file I/O |
/v1/skills | v1 | List custom skills installed in the workspace |
/v1/skills/{name} | v1 | Install (POST zip) / uninstall (DELETE) a custom skill. See Skills |
/v1/sessions/{id}/messages | v1 | SSE streaming. Returns X-Response-Id header. Every event carries a standard SSE id: <seq> line and a data.sequence_number mirror — pick whichever your client reads more easily. Optional Idempotency-Key for safe retries — see Idempotency. |
/v1/sessions/{id}/responses/{rid}/events | v1 | GET — resume a session-turn stream after disconnect. See Resume. |
/v1/sessions/{id}/responses/{rid}/cancel | v1 | POST — abort an in-flight session turn. See Cancel. |
/v1/sessions/{id}/tool_results | v1 | Resume a session-mode tool call. See Tool calling |
/v1/responses | v1 | Stateless OpenAI-compatible function calling. Returns X-Response-Id header. Optional Idempotency-Key for stream=true retries. See Tool calling. |
/v1/responses/{rid}/events | v1 | GET — resume a /v1/responses stream after disconnect. Auth-scoped to original caller. See Resume. |
/v1/responses/{rid}/cancel | v1 | POST — abort an in-flight /v1/responses stream. See Cancel. |
/v1/usage | v1 | Includes both rate-limit and credit balance |
Future endpoints will be additive within /v1/. Breaking changes (if any) will land under /v2/.