Skip to main content
GET
/
agents
/
{agent_id}
Get Agent by ID
curl --request GET \
  --url https://api.example.com/agents/{agent_id}
{
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "namespace_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "registered_at": "2023-11-07T05:31:56Z",
  "registration_metadata": {},
  "status": "ACTIVE",
  "status_reason": "<string>"
}

Path Parameters

​
agent_id
string
required

Response

Successful Response

​
created_at
string<date-time>
required

The timestamp when the agent was created

​
description
string
required

The description of the action.

​
id
string
required

The unique identifier of the agent.

​
name
string
required

The agent name (unique within namespace).

​
namespace_id
string
required

The namespace ID this agent belongs to.

​
updated_at
string<date-time>
required

The timestamp when the agent was last updated

​
agent_input_type
enum<string> | null

The type of input the agent expects.

Available options:
text,
json
​
registered_at
string<date-time> | null

The timestamp when the agent was last registered

​
registration_metadata
Registration Metadata · object

The metadata for the agent's registration.

​
status
enum<string>
default:ACTIVE

Agent status. Runtime statuses (Ready/Failed/Unhealthy) now live on Deployment.

Available options:
ACTIVE,
DELETED
​
status_reason
string | null

The reason for the status of the action.