Sign in

v5

latestOpenAPI 3.1.02026-08-04166362486.5 KB
deprecated_vector_stores

[DEPRECATED] Get a vector store

DEPRECATED: Use GET /stores/{store_identifier} instead

get/v1/vector_stores/{vector_store_identifier}

Path parameters

string required
OR
string uuid required

The ID or name of the vector store

Response

The details of the vector store

idstring required

Unique identifier for the vector store

namestring required

Name of the vector store

descriptionstring nullable

Detailed description of the vector store's purpose and contents

is_publicboolean

Whether the vector store can be accessed by anyone with valid login credentials

{"stackTrail":"components:schemas:VectorStore:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Additional metadata associated with the vector store","example":{"category":"support","language":"en"},"nullable":true}
status'expired' | 'in_progress' | 'completed'

Status of a store.

created_atstring date-time required

Timestamp when the vector store was created

updated_atstring date-time required

Timestamp when the vector store was last updated

last_active_atstring date-time nullable

Timestamp when the vector store was last used

usage_bytesinteger

Total storage usage in bytes

expires_atstring date-time nullable

Optional expiration timestamp for the vector store

object'vector_store'

Type of the object

Example response

{
  "id": "1b8b486e-16d0-400b-8868-04cd75217a7e",
  "name": "customer-support-kb",
  "description": "Contains customer support articles and FAQs",
  "metadata": {
    "category": "support",
    "language": "en"
  },
  "file_counts": {
    "pending": 5,
    "in_progress": 5,
    "cancelled": 2,
    "completed": 42,
    "failed": 1,
    "total": 50
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "usage_bytes": 1024000,
  "expires_at": "2024-01-01T00:00:00Z"
}