Get an agent

GET

/v1/agents/:id

GET

/v1/agents/:id

$ curl https://api.cloudraker.com/v1/agents/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "object": "agent",
3   "id": "ag_9f8b7c6d5e4a3b2c1d0e",
4   "name": "Customer Support Automation",
5   "description": "Automates initial customer support ticket triage and routing.",
6   "version": 3.4,
7   "tasks": [
8     {
9       "id": "task-1",
10       "title": "Analyze incoming ticket",
11       "executor": "agent",
12       "dependsOn": []
13     },
14     {
15       "id": "task-2",
16       "title": "Assign priority level",
17       "executor": "agent",
18       "dependsOn": [
19         "task-1"
20       ]
21     },
22     {
23       "id": "task-3",
24       "title": "Human review for escalation",
25       "executor": "human",
26       "dependsOn": [
27         "task-2"
28       ]
29     }
30   ],
31   "actions": [
32     {
33       "name": "Send notification email",
34       "approval": "auto"
35     },
36     {
37       "name": "Escalate to manager",
38       "approval": "before"
39     }
40   ],
41   "updatedAt": "2024-06-10T09:45:00Z"
42 }

Returns one agent: its steps, the actions it may take, their approval gates, and the version a new run will snapshot.

Read this before starting a run to know which steps will come back to you as human work, and which actions will ask for a sign-off.

An agent’s id is opaque — treat it as a string and do not parse it.

Learn more: Agents guide

Returns one agent: its steps, the actions it may take, their approval gates, and the `version` a new run will snapshot. Read this before starting a run to know which steps will come back to you as human work, and which actions will ask for a sign-off. <Note> An agent's `id` is opaque — treat it as a string and do not parse it. </Note> **Learn more:** [Agents guide](https://docs.cloudraker.com/capabilities/agents)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired>=1 character

Response

The agent.

object"agent"

idstring

namestring

descriptionstring

versiondouble

taskslist of objects

actionslist of objects

updatedAtstring

Errors

404

Not Found Error

429

Too Many Requests Error