Skip to main content
GET
/
api
/
v1
/
agents
/
{id}
Get Agent
curl --request GET \
  --url http://localhost:3301/api/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "execution_endpoint": {
    "url": "<string>",
    "method": "POST",
    "headers": {},
    "body": {}
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Path Parameters

​
id
string
required

Agent ID

Response

An AI agent with configurable settings

An AI agent with configurable settings

​
id
string<uuid>

Unique identifier

​
workspace_id
string<uuid>

Workspace ID

​
name
string

Agent name

Required string length: 1 - 255
​
description
string | null

Agent description

​
config_id
string<uuid> | null

Current active config ID

​
status
enum<string> | null

Agent status based on latest session

Available options:
running,
waiting_for_input,
completed,
failed
​
execution_endpoint
object

Execution endpoint configuration

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp