Get

GET

https://api.beta.superagent.sh/api/v1/vector-dbs/:vector_db_id

GET

/api/v1/vector-dbs/:vector_db_id

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

Try it

200Retrieved

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

Get a single Vector Database

Path parameters

vector_db_idstringRequired

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a VectorDb record

Get

Path parameters

Headers

Response

Errors