Agent

List

GET

List all agents

Query parameters

skipintegerOptional

takeintegerOptional

Response

This endpoint returns an object

success

boolean

total_pages

integer

data

list of objectsOptional

Represents a Agent record

GET

1 curl https://api.beta.superagent.sh/api/v1/agents \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "success": true,
3   "total_pages": 1,
4   "data": [
5     {
6       "id": "id",
7       "type": "SUPERAGENT",
8       "name": "name",
9       "description": "description",
10       "isActive": true,
11       "createdAt": "2024-01-15T09:30:00Z",
12       "updatedAt": "2024-01-15T09:30:00Z",
13       "apiUserId": "apiUserId",
14       "avatar": "avatar",
15       "initialMessage": "initialMessage",
16       "llms": [
17         {
18           "agentId": "agentId",
19           "llmId": "llmId",
20           "createdAt": "2024-01-15T09:30:00Z",
21           "updatedAt": "2024-01-15T09:30:00Z"
22         }
23       ],
24       "llmModel": "GPT_3_5_TURBO",
25       "prompt": "prompt",
26       "apiUser": {
27         "id": "id",
28         "createdAt": "2024-01-15T09:30:00Z",
29         "updatedAt": "2024-01-15T09:30:00Z"
30       },
31       "datasources": [
32         {
33           "agentId": "agentId",
34           "datasourceId": "datasourceId",
35           "createdAt": "2024-01-15T09:30:00Z",
36           "updatedAt": "2024-01-15T09:30:00Z"
37         }
38       ],
39       "tools": [
40         {
41           "agentId": "agentId",
42           "toolId": "toolId",
43           "createdAt": "2024-01-15T09:30:00Z",
44           "updatedAt": "2024-01-15T09:30:00Z"
45         }
46       ],
47       "workflowSteps": [
48         {
49           "id": "id",
50           "order": 1,
51           "workflowId": "workflowId",
52           "createdAt": "2024-01-15T09:30:00Z",
53           "updatedAt": "2024-01-15T09:30:00Z",
54           "agentId": "agentId"
55         }
56       ],
57       "metadata": {
58         "key": "value"
59       },
60       "outputSchema": "outputSchema"
61     }
62   ]
63 }

Built with

1	curl https://api.beta.superagent.sh/api/v1/agents \
2	-H "Authorization: Bearer <token>"

1	{
2	"success": true,
3	"total_pages": 1,
4	"data": [
5	{
6	"id": "id",
7	"type": "SUPERAGENT",
8	"name": "name",
9	"description": "description",
10	"isActive": true,
11	"createdAt": "2024-01-15T09:30:00Z",
12	"updatedAt": "2024-01-15T09:30:00Z",
13	"apiUserId": "apiUserId",
14	"avatar": "avatar",
15	"initialMessage": "initialMessage",
16	"llms": [
17	{
18	"agentId": "agentId",
19	"llmId": "llmId",
20	"createdAt": "2024-01-15T09:30:00Z",
21	"updatedAt": "2024-01-15T09:30:00Z"
22	}
23	],
24	"llmModel": "GPT_3_5_TURBO",
25	"prompt": "prompt",
26	"apiUser": {
27	"id": "id",
28	"createdAt": "2024-01-15T09:30:00Z",
29	"updatedAt": "2024-01-15T09:30:00Z"
30	},
31	"datasources": [
32	{
33	"agentId": "agentId",
34	"datasourceId": "datasourceId",
35	"createdAt": "2024-01-15T09:30:00Z",
36	"updatedAt": "2024-01-15T09:30:00Z"
37	}
38	],
39	"tools": [
40	{
41	"agentId": "agentId",
42	"toolId": "toolId",
43	"createdAt": "2024-01-15T09:30:00Z",
44	"updatedAt": "2024-01-15T09:30:00Z"
45	}
46	],
47	"workflowSteps": [
48	{
49	"id": "id",
50	"order": 1,
51	"workflowId": "workflowId",
52	"createdAt": "2024-01-15T09:30:00Z",
53	"updatedAt": "2024-01-15T09:30:00Z",
54	"agentId": "agentId"
55	}
56	],
57	"metadata": {
58	"key": "value"
59	},
60	"outputSchema": "outputSchema"
61	}
62	]
63	}