Update

PATCH

https://api.beta.superagent.sh/api/v1/api-keys/:id

PATCH

/api/v1/api-keys/:id

1 import { SuperAgentClient } from "superagentai-js";
2 
3 const superAgent = new SuperAgentClient({ token: "YOUR_TOKEN" });
4 await superAgent.apiKey.update("id", {
5     name: "name"
6 });

Try it

200Updated

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

Update an API key

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringRequired

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a ApiKey record

Update

Path parameters

Headers

Request

Response

Errors