List Agents

GET/agents

List all registered agents, optionally filtered by query parameters.

Query ParametersExpand Collapse

agent_card_metadata: optional string

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.

limit: optional number

Limit

minimum1

order_by: optional string

Field to order by

order_direction: optional string

Order direction (asc or desc)

page_number: optional number

Page number

minimum1

task_id: optional string

Task ID

ReturnsExpand Collapse

id: string

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:

"sync"

"async"

"agentic"

created_at: string

The timestamp when the agent was created

formatdate-time

description: string

The description of the action.

name: string

The unique name of the agent.

updated_at: string

The timestamp when the agent was last updated

formatdate-time

agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:

"text"

"json"

production_deployment_id: optional string

ID of the current production deployment.

registered_at: optional string

The timestamp when the agent was last registered

formatdate-time

registration_metadata: optional map[unknown]

The metadata for the agent’s registration.

status: optional "Ready" or "Failed" or "Unknown" or 3 more

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:

"Ready"

"Failed"

"Unknown"

"Deleted"

"Unhealthy"

"BuildOnly"

status_reason: optional string

The reason for the status of the action.

List Agents

curl http://localhost:5003/agents \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY"

[
  {
    "id": "id",
    "acp_type": "sync",
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "agent_input_type": "text",
    "production_deployment_id": "production_deployment_id",
    "registered_at": "2019-12-27T18:11:19.117Z",
    "registration_metadata": {
      "foo": "bar"
    },
    "status": "Ready",
    "status_reason": "status_reason"
  }
]

Returns Examples

[
  {
    "id": "id",
    "acp_type": "sync",
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "agent_input_type": "text",
    "production_deployment_id": "production_deployment_id",
    "registered_at": "2019-12-27T18:11:19.117Z",
    "registration_metadata": {
      "foo": "bar"
    },
    "status": "Ready",
    "status_reason": "status_reason"
  }
]