API User

Create

POST

Create a new API user

Request

This endpoint expects an object.

stringRequired

firstName

stringOptional

lastName

stringOptional

company

stringOptional

anonymousId

stringOptional

Response

This endpoint returns an object

success

boolean

data

objectOptional

Represents a ApiUser record

POST

1 curl -X POST https://api.beta.superagent.sh/api/v1/api-users \
2      -H "Content-Type: application/json" \
3      -d '{
4   "email": "email"
5 }'

200Successful

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

Built with

1	curl -X POST https://api.beta.superagent.sh/api/v1/api-users \
2	-H "Content-Type: application/json" \
3	-d '{
4	"email": "email"
5	}'

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