Create

POST

Create a new datasource

Request

This endpoint expects an object.

namestringRequired

typestringRequired

descriptionstringOptional

contentstringOptional

urlstringOptional

metadatamap from strings to anyOptional

vectorDbIdstringOptional

embeddingsModelProvider"OPENAI" or "AZURE_OPENAI"Optional

Allowed values: OPENAIAZURE_OPENAI

An enumeration.

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a Datasource record

POST

1 curl -X POST https://api.beta.superagent.sh/api/v1/datasources \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "name",
6   "type": "type"
7 }'

200Successful

1 {
2   "success": true,
3   "data": {
4     "id": "id",
5     "name": "name",
6     "type": "TXT",
7     "apiUserId": "apiUserId",
8     "createdAt": "2024-01-15T09:30:00Z",
9     "updatedAt": "2024-01-15T09:30:00Z",
10     "status": "IN_PROGRESS",
11     "content": "content",
12     "description": "description",
13     "url": "url",
14     "apiUser": {
15       "id": "id",
16       "createdAt": "2024-01-15T09:30:00Z",
17       "updatedAt": "2024-01-15T09:30:00Z",
18       "token": "token",
19       "email": "email",
20       "agents": [
21         {
22           "id": "id",
23           "type": "SUPERAGENT",
24           "name": "name",
25           "description": "description",
26           "isActive": true,
27           "createdAt": "2024-01-15T09:30:00Z",
28           "updatedAt": "2024-01-15T09:30:00Z",
29           "apiUserId": "apiUserId"
30         }
31       ],
32       "llms": [
33         {
34           "id": "id",
35           "provider": "OPENAI",
36           "apiKey": "apiKey",
37           "createdAt": "2024-01-15T09:30:00Z",
38           "updatedAt": "2024-01-15T09:30:00Z",
39           "apiUserId": "apiUserId"
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     "metadata": "metadata",
92     "datasources": [
93       {
94         "agentId": "agentId",
95         "datasourceId": "datasourceId",
96         "createdAt": "2024-01-15T09:30:00Z",
97         "updatedAt": "2024-01-15T09:30:00Z"
98       }
99     ],
100     "vectorDb": {
101       "id": "id",
102       "provider": "PINECONE",
103       "createdAt": "2024-01-15T09:30:00Z",
104       "updatedAt": "2024-01-15T09:30:00Z",
105       "apiUserId": "apiUserId",
106       "options": {
107         "key": "value"
108       },
109       "apiUser": {
110         "id": "id",
111         "createdAt": "2024-01-15T09:30:00Z",
112         "updatedAt": "2024-01-15T09:30:00Z"
113       }
114     },
115     "vectorDbId": "vectorDbId"
116   }
117 }

Built with

1	curl -X POST https://api.beta.superagent.sh/api/v1/datasources \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"type": "type"
7	}'

1	{
2	"success": true,
3	"data": {
4	"id": "id",
5	"name": "name",
6	"type": "TXT",
7	"apiUserId": "apiUserId",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z",
10	"status": "IN_PROGRESS",
11	"content": "content",
12	"description": "description",
13	"url": "url",
14	"apiUser": {
15	"id": "id",
16	"createdAt": "2024-01-15T09:30:00Z",
17	"updatedAt": "2024-01-15T09:30:00Z",
18	"token": "token",
19	"email": "email",
20	"agents": [
21	{
22	"id": "id",
23	"type": "SUPERAGENT",
24	"name": "name",
25	"description": "description",
26	"isActive": true,
27	"createdAt": "2024-01-15T09:30:00Z",
28	"updatedAt": "2024-01-15T09:30:00Z",
29	"apiUserId": "apiUserId"
30	}
31	],
32	"llms": [
33	{
34	"id": "id",
35	"provider": "OPENAI",
36	"apiKey": "apiKey",
37	"createdAt": "2024-01-15T09:30:00Z",
38	"updatedAt": "2024-01-15T09:30:00Z",
39	"apiUserId": "apiUserId"
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	"metadata": "metadata",
92	"datasources": [
93	{
94	"agentId": "agentId",
95	"datasourceId": "datasourceId",
96	"createdAt": "2024-01-15T09:30:00Z",
97	"updatedAt": "2024-01-15T09:30:00Z"
98	}
99	],
100	"vectorDb": {
101	"id": "id",
102	"provider": "PINECONE",
103	"createdAt": "2024-01-15T09:30:00Z",
104	"updatedAt": "2024-01-15T09:30:00Z",
105	"apiUserId": "apiUserId",
106	"options": {
107	"key": "value"
108	},
109	"apiUser": {
110	"id": "id",
111	"createdAt": "2024-01-15T09:30:00Z",
112	"updatedAt": "2024-01-15T09:30:00Z"
113	}
114	},
115	"vectorDbId": "vectorDbId"
116	}
117	}