List agents

GET

/v1/agents

GET

/v1/agents

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

1 {
2   "object": "list",
3   "data": [
4     {
5       "object": "agent",
6       "id": "a1b2c3d4e5f678901234567890abcdef",
7       "name": "Invoice Approval Workflow",
8       "description": "Automates the invoice approval process with human verification steps.",
9       "version": 3.4,
10       "tasks": [
11         {
12           "id": "task-1",
13           "title": "Extract invoice data",
14           "executor": "agent",
15           "dependsOn": []
16         },
17         {
18           "id": "task-2",
19           "title": "Verify invoice details",
20           "executor": "human",
21           "dependsOn": [
22             "task-1"
23           ]
24         },
25         {
26           "id": "task-3",
27           "title": "Approve payment",
28           "executor": "human",
29           "dependsOn": [
30             "task-2"
31           ]
32         },
33         {
34           "id": "task-4",
35           "title": "Record payment in system",
36           "executor": "agent",
37           "dependsOn": [
38             "task-3"
39           ]
40         }
41       ],
42       "actions": [
43         {
44           "name": "Send approval notification",
45           "approval": "before"
46         },
47         {
48           "name": "Finalize payment",
49           "approval": "output"
50         }
51       ],
52       "updatedAt": "2024-06-10T09:45:00Z"
53     }
54   ]
55 }

Lists the agents your organization can run.

An agent is a reviewed, versioned automation: a list of steps, some done by the agent itself and some by a person, plus the saved actions it may take and where a human sign-off is required. Only active agents appear here.

Each entry carries:

Field	What it tells you
`tasks[]`	The step ledger — `executor: "human"` marks the ones a person completes
`actions[]`	What the agent may do, and its `approval` gate
`version`	The revision a new run will snapshot

Start one with POST /v1/agent-runs.

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

Learn more: Agents guide

Lists the agents your organization can run. An agent is a reviewed, versioned automation: a list of steps, some done by the agent itself and some by a person, plus the saved actions it may take and where a human sign-off is required. Only active agents appear here. Each entry carries: | Field | What it tells you | | --- | --- | | `tasks[]` | The step ledger — `executor: "human"` marks the ones a person completes | | `actions[]` | What the agent may do, and its `approval` gate | | `version` | The revision a new run will snapshot | Start one with [POST /v1/agent-runs](https://docs.cloudraker.com/api/cloud-raker-api/agents/create-agent-run). <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.

Response

The agents.

object"list"

datalist of objects

Errors

429

Too Many Requests Error