API Key

Create

POST
Create a new API key

Request

This endpoint expects an object.
name
stringRequired

Response

This endpoint returns an object
success
boolean
data
objectOptional
Represents a ApiKey record
POST
1curl -X POST https://api.beta.superagent.sh/api/v1/api-keys \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "name": "name"
6}'
200
Successful
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 "apiKey": "apiKey",
11 "apiUser": {
12 "id": "id",
13 "createdAt": "2024-01-15T09:30:00Z",
14 "updatedAt": "2024-01-15T09:30:00Z",
15 "token": "token",
16 "email": "email",
17 "agents": [
18 {
19 "id": "id",
20 "type": "SUPERAGENT",
21 "name": "name",
22 "description": "description",
23 "isActive": true,
24 "createdAt": "2024-01-15T09:30:00Z",
25 "updatedAt": "2024-01-15T09:30:00Z",
26 "apiUserId": "apiUserId"
27 }
28 ],
29 "llms": [
30 {
31 "id": "id",
32 "provider": "OPENAI",
33 "apiKey": "apiKey",
34 "createdAt": "2024-01-15T09:30:00Z",
35 "updatedAt": "2024-01-15T09:30:00Z",
36 "apiUserId": "apiUserId"
37 }
38 ],
39 "datasources": [
40 {
41 "id": "id",
42 "name": "name",
43 "type": "TXT",
44 "apiUserId": "apiUserId",
45 "createdAt": "2024-01-15T09:30:00Z",
46 "updatedAt": "2024-01-15T09:30:00Z",
47 "status": "IN_PROGRESS"
48 }
49 ],
50 "tools": [
51 {
52 "id": "id",
53 "name": "name",
54 "description": "description",
55 "type": "ALGOLIA",
56 "returnDirect": true,
57 "createdAt": "2024-01-15T09:30:00Z",
58 "updatedAt": "2024-01-15T09:30:00Z",
59 "apiUserId": "apiUserId"
60 }
61 ],
62 "workflows": [
63 {
64 "id": "id",
65 "name": "name",
66 "createdAt": "2024-01-15T09:30:00Z",
67 "updatedAt": "2024-01-15T09:30:00Z",
68 "apiUserId": "apiUserId"
69 }
70 ],
71 "vectorDb": [
72 {
73 "id": "id",
74 "provider": "PINECONE",
75 "createdAt": "2024-01-15T09:30:00Z",
76 "updatedAt": "2024-01-15T09:30:00Z",
77 "apiUserId": "apiUserId"
78 }
79 ],
80 "workflowConfigs": [
81 {
82 "id": "id",
83 "createdAt": "2024-01-15T09:30:00Z",
84 "updatedAt": "2024-01-15T09:30:00Z",
85 "workflowId": "workflowId"
86 }
87 ],
88 "apiKeys": [
89 {
90 "id": "id",
91 "name": "name",
92 "displayApiKey": "displayApiKey",
93 "createdAt": "2024-01-15T09:30:00Z",
94 "updatedAt": "2024-01-15T09:30:00Z",
95 "apiUserId": "apiUserId"
96 }
97 ]
98 }
99 }
100}