DocsAPI reference

List agents

get/api/agents
Authentication
Bearer token
Retries
Safe to repeat
Body
None
Version
2026-09-03

Query parameters#

  • pageinteger

    Default: 1·≥ 1

  • page_sizeinteger

    Default: 20·≥ 1 and ≤ 100

Responses#

  • 200OKapplication/json

    PaginatedResponse_AgentRead_

    • itemsarray of AgentReadrequired
      38 fieldsAgentRead
      • allowed_domainsarray of string | nullrequired
      • contact_fields_configarray of anyrequired
      • created_atstring (date-time)required
      • descriptionstring | nullrequired
      • directory_configobject | nullrequired
      • fallback_messagestring | nullrequired
      • handoff_enabledbooleanrequired
      • idstringrequired
      • indexed_chunk_countintegerrequired
      • is_publicbooleanrequired
      • languagestringrequired
      • last_errorstring | nullrequired
      • lead_capture_configobject | nullrequired
      • llm_providerLLMProviderTyperequired

        platform uses the credentials this deployment is configured with; byok ("bring your own key") uses the tenant's own Anthropic key; custom posts to an owner-supplied OpenAI-compatible endpoint.

        One of: platform, byok, custom

      • max_tokensintegerrequired
      • modelstring | nullrequired
      • monthly_message_capinteger | nullrequired
      • namestringrequired
      • org_idstringrequired
      • public_keystringrequired
      • rate_limit_per_minuteintegerrequired
      • starter_questionsarray of stringrequired
      • statusAgentStatusrequired

        One of: draft, active, paused, archived

      • strict_kb_modebooleanrequired
      • system_promptstringrequired
      • temperaturenumberrequired
      • thinking_enabledbooleanrequired
      • total_conversationsintegerrequired
      • total_messagesintegerrequired
      • updated_atstring (date-time)required
      • welcome_messagestring | nullrequired
      • widget_themeobjectrequired
      • custom_endpoint_configobject | null
      • field_discoveryboolean

        Default: false

      • has_api_keyboolean

        Default: false

      • language_configobject
      • messages_this_monthinteger | null
      • thinking_budget_tokensinteger

        Default: 2048

    • pageintegerrequired
    • page_sizeintegerrequired
    • totalintegerrequired
    • has_moreboolean

      Default: false

    • next_cursorstring | null
    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Agents endpoints#

Something unclear or missing? Tell us and we’ll fix it.