Skip to main content
GET
Get ai agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the requested item

Example:

"01a0206f-ed6f-7791-9741-adac677a116c"

Response

The requested AI agent

The fields shared by every AI agent type

id
string<uuid>
required
read-only

Unique identifier for the AI agent

Example:

"01a0206f-ab5d-7a94-b390-0e72d746d00a"

name
string
required

Name of the AI Agent

Example:

"Test AI Agent"

status
enum<number>
required

Status of the AI Agent

Available options:
-1,
0,
1
Example:

1

timestamp_created
string
required
read-only

Timestamp when the AI agent was created

Example:

"2026-08-20T18:29:44.413Z"

timestamp_updated
string
required
read-only

Timestamp when the AI agent was updated

Example:

"2026-08-20T18:29:44.413Z"

configuration_mode
null | enum<string>
required

How much autonomy the agent runs with. Null for agent types that have no autonomy setting, and for agents whose mode is not configured yet.

Available options:
copilot,
fully_automatic,
null
Example:

"copilot"

type
null | enum<number>

Type of the AI Agent

Available options:
1,
2,
3,
4,
6,
7,
8,
9,
10
Example:

1