Agents

List all registered agents, optionally filtered by query parameters.

get/agents

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

task_idstring nullable

Task ID

limitinteger

Limit

page_numberinteger

Page number

order_bystring nullable

Field to order by

order_directionstring

Order direction (asc or desc)

agent_card_metadatastring nullable

JSON-encoded object used to filter agents on registration_metadata.agent_card.metadata via JSONB containment. Example: {"permits_capable": true}. Only matches cards published through the direct registration path: registrations that carry a deployment_id write the card to the deployment record instead of registration_metadata, so those agents never match this filter.

Response

Successful Response

idstring required

The unique identifier of the agent.

namestring required

The unique name of the agent.

descriptionstring required

The description of the action.

status'Ready' | 'Failed' | 'Unknown' | 'Deleted' | 'Unhealthy' | 'BuildOnly'
acp_type'sync' | 'async' | 'agentic' required
status_reasonstring nullable

The reason for the status of the action.

created_atstring date-time required

The timestamp when the agent was created

updated_atstring date-time required

The timestamp when the agent was last updated

registration_metadataobject nullable

The metadata for the agent's registration.

registered_atstring date-time nullable

The timestamp when the agent was last registered

agent_input_type'text' | 'json'
production_deployment_idstring nullable

ID of the current production deployment.

Changes