Get

GET

https://api.beta.superagent.sh/api/v1/tools/:tool_id

GET

/api/v1/tools/:tool_id

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

Try it

200Retrieved

1 {
2   "success": true,
3   "data": {
4     "id": "id",
5     "name": "name",
6     "description": "description",
7     "type": "ALGOLIA",
8     "returnDirect": true,
9     "createdAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "apiUserId": "apiUserId",
12     "metadata": "metadata",
13     "apiUser": {
14       "id": "id",
15       "createdAt": "2024-01-15T09:30:00Z",
16       "updatedAt": "2024-01-15T09:30:00Z",
17       "token": "token",
18       "email": "email",
19       "agents": [
20         {
21           "id": "id",
22           "type": "SUPERAGENT",
23           "name": "name",
24           "description": "description",
25           "isActive": true,
26           "createdAt": "2024-01-15T09:30:00Z",
27           "updatedAt": "2024-01-15T09:30:00Z",
28           "apiUserId": "apiUserId"
29         }
30       ],
31       "llms": [
32         {
33           "id": "id",
34           "provider": "OPENAI",
35           "apiKey": "apiKey",
36           "createdAt": "2024-01-15T09:30:00Z",
37           "updatedAt": "2024-01-15T09:30:00Z",
38           "apiUserId": "apiUserId"
39         }
40       ],
41       "datasources": [
42         {
43           "id": "id",
44           "name": "name",
45           "type": "TXT",
46           "apiUserId": "apiUserId",
47           "createdAt": "2024-01-15T09:30:00Z",
48           "updatedAt": "2024-01-15T09:30:00Z",
49           "status": "IN_PROGRESS"
50         }
51       ],
52       "workflows": [
53         {
54           "id": "id",
55           "name": "name",
56           "createdAt": "2024-01-15T09:30:00Z",
57           "updatedAt": "2024-01-15T09:30:00Z",
58           "apiUserId": "apiUserId"
59         }
60       ],
61       "vectorDb": [
62         {
63           "id": "id",
64           "provider": "PINECONE",
65           "createdAt": "2024-01-15T09:30:00Z",
66           "updatedAt": "2024-01-15T09:30:00Z",
67           "apiUserId": "apiUserId"
68         }
69       ],
70       "workflowConfigs": [
71         {
72           "id": "id",
73           "createdAt": "2024-01-15T09:30:00Z",
74           "updatedAt": "2024-01-15T09:30:00Z",
75           "workflowId": "workflowId"
76         }
77       ],
78       "apiKeys": [
79         {
80           "id": "id",
81           "name": "name",
82           "displayApiKey": "displayApiKey",
83           "createdAt": "2024-01-15T09:30:00Z",
84           "updatedAt": "2024-01-15T09:30:00Z",
85           "apiUserId": "apiUserId"
86         }
87       ]
88     },
89     "tools": [
90       {
91         "agentId": "agentId",
92         "toolId": "toolId",
93         "createdAt": "2024-01-15T09:30:00Z",
94         "updatedAt": "2024-01-15T09:30:00Z"
95       }
96     ],
97     "toolConfig": {
98       "key": "value"
99     }
100   }
101 }

Get a specific tool

Path parameters

tool_idstringRequired

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a Tool record

Get

Path parameters

Headers

Response

Errors