API reference

The 14 endpoints of the public /v1 surface, generated from the API's own OpenAPI document (v1.0.0). Every one of them takes an X-Api-Key header.

Download the OpenAPI file to generate a client or load the API into a tool. It holds exactly these operations, declares the X-Api-Key header as its security scheme, and names this API's address under servers.

GET /v1/organisation/inference-privacy

The calling API key's organisation's inference privacy verification.

POST /v1/agents/{agentId}/runs

Start an Amy run; streams tokens, tool calls/results, usage, and a terminal event over SSE.

POST /v1/agents/{agentId}/runs/await

Start an Amy run and return one JSON result when it completes.

POST /v1/agents/{agentId}/runs/submit

Submit an Amy run for asynchronous execution; returns 202 + a run id to poll via GET /v1/runs/{runId}.

GET /v1/runs/{runId}

The full persisted run (status, messages, usage); 404 covers cross-tenant ids and another client's runs.

POST /v1/runs/{runId}/approvals/{approvalId}

Resume an approval-paused run with approve/deny; streams the continuation over SSE.

POST /v1/runs/{runId}/retry

Retry a failed run from its committed trace — no tool is re-executed; streams the re-drive over SSE.

POST /v1/runs/{runId}/cancel

Cancel a run this client started; 404 covers cross-tenant ids and another client's runs.

GET /v1/conversations

One end user's conversations for the calling API-key client, most recently active first.

GET /v1/conversations/{conversationId}

One conversation's user and assistant text turns, in order; 404 unless it holds a run of this client for this end user.

POST /v1/files

Upload a file in one multipart request; returns a file id usable as attachmentFileIds.

DELETE /v1/files/{id}

Delete a file your API client uploaded; 404 covers every file that is not.

GET /v1/runs/{runId}/files/{fileId}/content

Stream the bytes of a file attached to this run; 404 covers cross-tenant, other-client and unlinked ids.

GET /v1/runs/{runId}/workspace-files/{interactionId}/content

Stream a file this run wrote with its file tools; 404 covers cross-tenant, other-client, unknown and non-produced ids.

Not listed here: the browser-authenticated Console API under /api/v1. An API key cannot call it, so it is not part of the surface you integrate against.