Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
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.

organizationId string

The organization this vector store belongs to.

createdBy string

User ID of the person who created this vector store.

createdAt string

ISO 8601 timestamp when the vector store was created.

updatedAt string

ISO 8601 timestamp when the vector store was last modified.

isActive boolean

Whether the vector store is active and available for use.

accessMode string

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

accessDepartments array optional

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

accessUsers array optional

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

fileCount integer

Number of files currently stored in this vector store.

dataSize integer

Total size of all files in bytes.

Example Vector Store

{
  "id": "vs_abc123",
  "name": "Product Documentation",
  "description": "Technical documentation for all products",
  "organizationId": "org_abc123",
  "createdBy": "uid_user123",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:22:00Z",
  "isActive": true,
  "accessMode": "organization",
  "accessDepartments": null,
  "accessUsers": null,
  "fileCount": 42,
  "dataSize": 15728640
}