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 match
• engine: 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_order query parameters
• Legacy syntax (deprecated): Use size and continuation_token query parameters
• If no pagination parameters are provided, returns a plain list
• Use the next_token from the response to fetch subsequent pages
• When next_token is null, you have reached the last page

Returns:

• Paginated list of vector store entities
• Total count of matching vector stores
• next_token for 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

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>'

200

{
  "items": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>"
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

x-selected-account-id · string · header · required

Selected Account ID

Path Parameters

project_id · string · required

Query Parameters

size · integer · default: 999 · deprecated

[DEPRECATED] Maximum number of vector stores to return per page. Use page_size instead.

Required range: 1 <= x <= 1000

Example:

20

continuation_token · string | null

Pagination token

ids · string[] | null

Filter by vector store IDs

created_at_start · string<date-time> | null

Filter by creation time (start)

created_at_end · string<date-time> | null

Filter by creation time (end)

engine · enum<string> | null

Filter by vector store engine type

Available options: sgp_knowledge_base, sgp_vector_store

name · string | null

Filter by vector store name (case-sensitive)

page_size · integer | null

Number of items per page

Required range: 1 <= x <= 100

sort_by · string | null

Field to sort by

sort_order · enum<string> | null

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

Response

200

application/json

List of vector stores retrieved successfully

items · VectorStoreEntity · object[] · required

Show child attributes

total_count · integer · required

next_token · string | null

prev_token · string | null