Agents

The AI agents that process incoming mail: their model, their system prompt, their prompt version history and the catalogue of models available. Eight tools.

See the Agent model and the LlmModel model.

---

agents_list

Read · scope inbox/agents · permission agents.list · GET /agents

List agents in the selected workspace.

Parameter	Type	Description
cursor	string	Opaque cursor from a previous page.
limit	integer	Page size, default 25, max 100.
sort	string	Sort keys, - prefix for descending.
llm_model	string	Filter by model, as provider/model.
external_id	string	Filter by the id in your system.
created_at_gte / created_at_lte	string	ISO 8601 range on created_at.

agents_get

Read · scope inbox/agents · permission agents.show · GET /agents/{id}

Fetch one agent by internal id or external_id, including its current version.

Parameter	Type	Description
id required	string	Internal id or external_id.

agents_create

Write · scope inbox/agents + write · permission agents.create · POST /agents

Create an agent. Version starts at 1.

Parameter	Type	Description
label required	string	Display name, 1–120 chars.
llm_model required	string	provider/model, routed through the Vercel AI Gateway.
system_message required	string	System prompt. Changing it bumps the agent version.
external_id	string	Id of the record in your system.
skills_repo	string | null	Git URL; branch or tag goes in the fragment (...git#branch).
custom_metadata	object	Free-form JSON owned by the caller.
idempotency_key	string	Replay guard, 8–255 chars.

agents_upsert

Write · scope inbox/agents + write · permission agents.create · PUT /agents

Create or update an agent, matched by id then external_id. A different system_message bumps the version.

Parameter	Type	Description
id	string (uuid)	Match by internal id first.
external_id	string	Match key in your system.
label	string	Display name, 1–120 chars.
llm_model	string	provider/model.
system_message	string	System prompt.
skills_repo	string | null	Git URL, branch or tag in the fragment.
custom_metadata	object	Free-form JSON.
idempotency_key	string	Replay guard.

agents_update

Write · scope inbox/agents + write · permission agents.update · PATCH /agents/{id}

Update an agent. Changing system_message snapshots a new immutable version; changing only label, model or skills repo does not.

Parameter	Type	Description
id required	string	Internal id or external_id.
label	string	Display name, 1–120 chars.
external_id	string	Id in your system.
llm_model	string	provider/model.
system_message	string	System prompt. Changing it bumps the version.
skills_repo	string | null	Git URL, branch or tag in the fragment.
custom_metadata	object	Free-form JSON.

agents_delete

Destructive · scope inbox/agents + write · permission agents.delete · DELETE /agents/{id}

Soft-delete an agent. Inboxes pointing at it stop processing until reassigned.

Parameter	Type	Description
id required	string	Internal id or external_id.

agents_versions_list

Read · scope inbox/agents · permission agents.show · GET /agents/{id}/versions

Prompt version history of an agent — each entry is the exact system_message a run executed with.

Parameter	Type	Description
id required	string	Internal id or external_id.
cursor	string	Opaque cursor from a previous page.
limit	integer	Page size, default 25, max 100.

models_list

Read · scope inbox/agents · permission agents.list · GET /models

Catalogue of LLM models available through the AI Gateway, with current prices. Takes no parameters.