List vector stores
curl --request GET \
--url https://api.example.com/v1/projects/{project_id}/vector-stores \
--header 'x-api-key: <api-key>' \
--header 'x-selected-account-id: <api-key>'import requests
url = "https://api.example.com/v1/projects/{project_id}/vector-stores"
headers = {
"x-api-key": "<api-key>",
"x-selected-account-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-selected-account-id': '<api-key>'}
};
fetch('https://api.example.com/v1/projects/{project_id}/vector-stores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/vector-stores",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-selected-account-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/projects/{project_id}/vector-stores"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-selected-account-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/projects/{project_id}/vector-stores")
.header("x-api-key", "<api-key>")
.header("x-selected-account-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/vector-stores")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"engine": "sgp_knowledge_base",
"created_at": "2023-11-07T05:31:56Z",
"external_id": "<string>"
}
],
"total_count": 123,
"next_token": "<string>",
"prev_token": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Vector Stores
List vector stores
Retrieve a paginated list of vector stores for a project.
This endpoint returns all vector stores associated with the specified project, with optional filtering by name and engine type.
Filtering:
name: Filter vector stores by exact name matchengine: Filter by vector store engine type (e.g., sgp_knowledge_base)ids: Filter by vector store IDs (list)created_at_start: Filter by creation time (start)created_at_end: Filter by creation time (end)project_id: Filter by project ID (if not provided in path)
Sorting:
sort_by: Field to sort by (id, created_at, engine, project_id)sort_order: Sort order (asc or desc)
Token-based Pagination:
- New syntax (recommended): Use
page_size,continuation_token,sort_by,sort_orderquery parameters - Legacy syntax (deprecated): Use
sizeandcontinuation_tokenquery parameters - If no pagination parameters are provided, returns a plain list
- Use the
next_tokenfrom the response to fetch subsequent pages - When
next_tokenisnull, you have reached the last page
Returns:
- Paginated list of vector store entities
- Total count of matching vector stores
next_tokenfor pagination (null if no more pages)
Example Response:
{
"items": [
{
"id": "vs_123456789",
"project_id": "proj_987654321",
"name": "My Knowledge Base",
"engine": "sgp_knowledge_base",
"created_at": "2024-01-15T10:30:00Z"
}
],
"total_count": 1,
"next_token": "eyJpZCI6InZlY3Rvcl9zdG9yZV8xMjM0NTY3ODkwYWJjZGVmIn0="
}
GET
/
v1
/
projects
/
{project_id}
/
vector-stores
List vector stores
curl --request GET \
--url https://api.example.com/v1/projects/{project_id}/vector-stores \
--header 'x-api-key: <api-key>' \
--header 'x-selected-account-id: <api-key>'import requests
url = "https://api.example.com/v1/projects/{project_id}/vector-stores"
headers = {
"x-api-key": "<api-key>",
"x-selected-account-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-selected-account-id': '<api-key>'}
};
fetch('https://api.example.com/v1/projects/{project_id}/vector-stores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/vector-stores",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-selected-account-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/projects/{project_id}/vector-stores"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-selected-account-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/projects/{project_id}/vector-stores")
.header("x-api-key", "<api-key>")
.header("x-selected-account-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/vector-stores")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"engine": "sgp_knowledge_base",
"created_at": "2023-11-07T05:31:56Z",
"external_id": "<string>"
}
],
"total_count": 123,
"next_token": "<string>",
"prev_token": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key for authentication
Selected Account ID
Path Parameters
Query Parameters
[DEPRECATED] Maximum number of vector stores to return per page. Use page_size instead.
Required range:
1 <= x <= 1000Example:
20
Pagination token
Filter by vector store IDs
Filter by creation time (start)
Filter by creation time (end)
Filter by vector store engine type
Available options:
sgp_knowledge_base, sgp_vector_store Filter by vector store name (case-sensitive)
Number of items per page
Required range:
1 <= x <= 100Field to sort by
Sort order (asc or desc) Enum for project sort fields. Note that only non-nullable fields can be sorted by (for details, see: https://github.com/djrobstep/sqlakeyset?tab=readme-ov-file#limitations ).
Available options:
asc, desc