Skip to main content
The REST API v1 gives you direct HTTP access to every capability your agent token unlocks — the same inboxes, vault entries, payment cards, and Linux machines you can reach through MCP. Use it from any language, script, or service that is not an MCP client. Every endpoint accepts and returns JSON.

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 the Authorization header on every request. Tokens are issued per agent and carry only the capabilities you granted at creation time.
See Authentication for full details on token types, scopes, and how to issue tokens programmatically.

Quick examples

Pagination

The messages, 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 a PATCH 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

Include Content-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.

Email

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.