Get

GET

Get a specific datasource

Path parameters

datasource_idstringRequired

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a Datasource record

GET

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

200Retrieved

1 {
2   "success": true,
3   "data": {
4     "id": "id",
5     "name": "name",
6     "content": "content",
7     "description": "description",
8     "url": "url",
9     "type": "TXT",
10     "apiUserId": "apiUserId",
11     "apiUser": {
12       "id": "id",
13       "token": "token",
14       "email": "email",
15       "createdAt": "2024-01-15T09:30:00Z",
16       "updatedAt": "2024-01-15T09:30:00Z",
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       "tools": [
40         {
41           "id": "id",
42           "name": "name",
43           "description": "description",
44           "type": "ALGOLIA",
45           "returnDirect": true,
46           "createdAt": "2024-01-15T09:30:00Z",
47           "updatedAt": "2024-01-15T09:30:00Z",
48           "apiUserId": "apiUserId"
49         }
50       ],
51       "workflows": [
52         {
53           "id": "id",
54           "name": "name",
55           "createdAt": "2024-01-15T09:30:00Z",
56           "updatedAt": "2024-01-15T09:30:00Z",
57           "apiUserId": "apiUserId"
58         }
59       ],
60       "vectorDb": [
61         {
62           "id": "id",
63           "provider": "PINECONE",
64           "createdAt": "2024-01-15T09:30:00Z",
65           "updatedAt": "2024-01-15T09:30:00Z",
66           "apiUserId": "apiUserId"
67         }
68       ],
69       "workflowConfigs": [
70         {
71           "id": "id",
72           "createdAt": "2024-01-15T09:30:00Z",
73           "updatedAt": "2024-01-15T09:30:00Z",
74           "workflowId": "workflowId"
75         }
76       ],
77       "apiKeys": [
78         {
79           "id": "id",
80           "name": "name",
81           "displayApiKey": "displayApiKey",
82           "createdAt": "2024-01-15T09:30:00Z",
83           "updatedAt": "2024-01-15T09:30:00Z",
84           "apiUserId": "apiUserId"
85         }
86       ]
87     },
88     "createdAt": "2024-01-15T09:30:00Z",
89     "updatedAt": "2024-01-15T09:30:00Z",
90     "metadata": "metadata",
91     "status": "IN_PROGRESS",
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       "options": {
104         "key": "value"
105       },
106       "createdAt": "2024-01-15T09:30:00Z",
107       "updatedAt": "2024-01-15T09:30:00Z",
108       "apiUserId": "apiUserId",
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 https://api.beta.superagent.sh/api/v1/datasources/datasource_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"success": true,
3	"data": {
4	"id": "id",
5	"name": "name",
6	"content": "content",
7	"description": "description",
8	"url": "url",
9	"type": "TXT",
10	"apiUserId": "apiUserId",
11	"apiUser": {
12	"id": "id",
13	"token": "token",
14	"email": "email",
15	"createdAt": "2024-01-15T09:30:00Z",
16	"updatedAt": "2024-01-15T09:30:00Z",
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	"tools": [
40	{
41	"id": "id",
42	"name": "name",
43	"description": "description",
44	"type": "ALGOLIA",
45	"returnDirect": true,
46	"createdAt": "2024-01-15T09:30:00Z",
47	"updatedAt": "2024-01-15T09:30:00Z",
48	"apiUserId": "apiUserId"
49	}
50	],
51	"workflows": [
52	{
53	"id": "id",
54	"name": "name",
55	"createdAt": "2024-01-15T09:30:00Z",
56	"updatedAt": "2024-01-15T09:30:00Z",
57	"apiUserId": "apiUserId"
58	}
59	],
60	"vectorDb": [
61	{
62	"id": "id",
63	"provider": "PINECONE",
64	"createdAt": "2024-01-15T09:30:00Z",
65	"updatedAt": "2024-01-15T09:30:00Z",
66	"apiUserId": "apiUserId"
67	}
68	],
69	"workflowConfigs": [
70	{
71	"id": "id",
72	"createdAt": "2024-01-15T09:30:00Z",
73	"updatedAt": "2024-01-15T09:30:00Z",
74	"workflowId": "workflowId"
75	}
76	],
77	"apiKeys": [
78	{
79	"id": "id",
80	"name": "name",
81	"displayApiKey": "displayApiKey",
82	"createdAt": "2024-01-15T09:30:00Z",
83	"updatedAt": "2024-01-15T09:30:00Z",
84	"apiUserId": "apiUserId"
85	}
86	]
87	},
88	"createdAt": "2024-01-15T09:30:00Z",
89	"updatedAt": "2024-01-15T09:30:00Z",
90	"metadata": "metadata",
91	"status": "IN_PROGRESS",
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	"options": {
104	"key": "value"
105	},
106	"createdAt": "2024-01-15T09:30:00Z",
107	"updatedAt": "2024-01-15T09:30:00Z",
108	"apiUserId": "apiUserId",
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	}