Skip to navigation
Developer ReferenceAPI ReferenceAgents

List Agents

List the agents the organization may run, or the full catalog.

The single authoritative source of agent availability for clients (extension, Console, integrations). By default the returned list already reflects every per-org gate — style-agent mode, per-agent on/off, and the no-LLM flag — so clients must not re-derive availability; the no_llm flag is returned alongside so they can render the Style-Agent-only state directly. Pass include_unavailable=true for the full catalog (per-org gates skipped), e.g. an internal tool resolving an agent id regardless of org config.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Items per page (max 100)

categorystring or nullOptional

Filter agents by category name (case-insensitive substring match)

include_unavailablebooleanOptionalDefaults to false

Return the full agent catalog instead of only the agents this organization may run. When false (default) the list is filtered by style-agent mode, per-agent on/off, and the no-LLM flag; when true those per-org gates are skipped.

Response

Successful Response
agentslist of objects
Agents for the current page
totalinteger
Total number of agents matching filters
pageinteger

Current page number (1-based)

page_sizeinteger
Number of items per page
total_pagesinteger
Total number of pages
no_llmboolean

When true, the organization has disabled all LLM-powered agents; only the deterministic Style Agent is available and, unless include_unavailable is set, agents contains it alone (Style-Agent-only).

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error