Base URL
OpenAPI spec
A machine-readable OpenAPI document is available for import into Postman, Insomnia, or any other HTTP client:Authentication
Pass your agent token as a Bearer token in theAuthorization header on every request. Tokens are issued per agent and carry only the capabilities you granted at creation time.
Quick examples
Pagination
Themessages, threads, and drafts endpoints are cursor-paginated. Pass limit (1–100) to control page size and cursor to advance through results. Each response that has more pages includes a next_cursor field — pass its value as cursor on your next request.
Paginating messages
Read state
Fetching messages or threads through the API does not mark conversations as read. To mark a conversation read for the agent, send aPATCH to /api/v1/threads/:id with {"read": true}. Read state is tracked per side — the agent tracks what it has handled, and members track what they have seen.
Content-Type
IncludeContent-Type: application/json on all POST and PATCH requests that carry a body.
POST with a JSON body
Explore the API
Authentication
Agent tokens, organization keys, OAuth 2.1 scopes, and how to issue tokens via API.
Errors
HTTP status codes, JSON error envelope format, and idempotency guidance.
Read, send, reply, forward, draft, and manage mailbox folders.
Vault
List credentials, retrieve values, generate TOTP codes, and manage accounts.
Machines
Create, run, snapshot, and delete Ubuntu machines for your agents.