List invocable agents

Responses

• 200 The invocable agents
  • agents array of Agent required

    Every agent you can invoke.

    • name string required

      The agent’s name. This is the id you invoke it by.

    • identity string required

      The agent’s one-line statement of what it is, from its own manifest.

    • description string required

      What the agent does.

    • createJobCredits integer required

      Credits charged when a job is created for this agent. Charged at creation, not at completion.

    • inputSchema object required

      JSON Schema for this agent’s `input`. Validate against it before creating a job.

    • outputSchema object required

      JSON Schema for this agent’s `result`.

    • model string required

      Which model role this agent binds: `judge` for evaluation, `writer` for generation, `none` for a deterministic task with no model call.

      judgewriternone
    • tools array of string required

      The tools this agent is allowed to use. An allowlist: it can use nothing else.

    • tier string required

      How the result reaches you. `sync` runs in-band and returns the result on the create response. `queue` acknowledges immediately and you poll for the result — this is the default. `durable` is reserved and not in use.

      syncqueuedurable
    • theme string

      The agent’s category, when its manifest declares one. Absent otherwise.

    • kind string required

      `agent` when it orchestrates sub-agents, `task` when it is a single leaf step.

      agenttask
    • subAgents array of string required

      The agents this one orchestrates. Empty on a leaf task.

    • example any

      A canonical example input, when the manifest supplies one. The fastest way to see the input shape without reading the schema.

    • prompts array of object required

      The prompt atoms this agent composes, flattened.

      • name string required

        The prompt atom’s name.

      • version integer required

        Its version. Bumped when the wording changes, so you can tell whether two runs used the same instructions.

      • clauses array of string required

        The instruction clauses this atom contributes.

      • userTemplateSource string required

        The user-message template, as written.

• 401 No or invalid credential
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.

• 403 Missing agent:read
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.