Get Agent by Name

Get an agent by its unique name.

GET /agents/name/{agent_name}

Get Agent by Name

cURL

curl --request GET \
  --url https://api.example.com/agents/name/{agent_name}

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "Unknown",
  "status_reason": "<string>",
  "registration_metadata": {},
  "registered_at": "2023-11-07T05:31:56Z",
  "production_deployment_id": "<string>"
}

Path Parameters

agent_name · string · required

Response

200

application/json

Successful Response

id · string · required

The unique identifier of the agent.

name · string · required

The unique name of the agent.

description · string · required

The description of the action.

acp_type · enum<string> · required

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

Available options: sync, async, agentic

created_at · string<date-time> · required

The timestamp when the agent was created

updated_at · string<date-time> · required

The timestamp when the agent was last updated

status · enum<string> · default: Unknown

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

Available options: Ready, Failed, Unknown, Deleted, Unhealthy

status_reason · string | null

The reason for the status of the action.

registration_metadata · Registration Metadata · object

The metadata for the agent's registration.

registered_at · string<date-time> | null

The timestamp when the agent was last registered

agent_input_type · enum<string> | null

The type of input the agent expects.

Available options: text, json

production_deployment_id · string | null

ID of the current production deployment.