Skip to content
Last updated

Represents a vector store containing embedded documents for semantic search and retrieval. Vector stores enable AI assistants to access and search through custom knowledge bases.

Properties

id string

Unique identifier for the vector store. Format: vs_ followed by alphanumeric characters.

name string

Human-readable name for the vector store.

description string optional

Brief description of the vector store's purpose and contents.

organization_id string

The organization this vector store belongs to.

created_by string

User ID of the person who created this vector store.

created_at string

ISO 8601 timestamp when the vector store was created.

updated_at string

ISO 8601 timestamp when the vector store was last modified.

is_active boolean

Whether the vector store is active and available for use.

access_mode string

Access control for the vector store. Values: private, department, organization, public.

access_departments array optional

Array of department IDs that have access to this vector store when access_mode is department.

access_users array optional

Array of user IDs with explicit access to this vector store when access_mode is private.

file_count integer

Number of files currently stored in this vector store.

data_size integer

Total size of all files in bytes.