Agents

List agents

Requires scope: read. Lists the workspace's agents, newest first. A key tied to one agent lists that agent and no other.

get/v1/agents

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/agents
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (1–100).

cursorstring

Opaque cursor from a previous page's next_cursor.

status'live' | 'all' | 'active' | 'paused' | 'archived'

Which agents to list. Defaults to live — everything except archived — because an archived agent cannot send, so listing tombstones by default answers a different question than the one you asked. Use all to include them, or filter to one exact status.

Response

A page of agents.

has_moreboolean required

True when more items follow this page: pass next_cursor as cursor to get them.

next_cursorstring

Pass as cursor to fetch the next page. Absent on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.