Create a new vector store for storing and querying document embeddings.
The vector store name must be unique within your account and follow naming conventions (3-63 characters, alphanumeric with hyphens/underscores). Once created, the embedding configuration and dimensions are immutable and cannot be changed. To use a different model, you must create a new vector store.
Embedding Configuration: Provide embedding_config (for base or custom model deployments),
embedding_model (shorthand for a base model), or dimensions only (raw embeddings).
embedding_config or embedding_model: dimensions are auto-derived, and documents can be
upserted with text content (auto-embedded) or with pre-computed embeddings.dimensions only: the store accepts only pre-computed embeddings. Semantic/hybrid queries
are not supported (lexical search only).Indexed Fields: Optionally specify metadata fields to index at creation time. Only indexed fields can be used for filtering — indexing is required, not just a performance optimization. Additional indexed fields can be added later using the configure endpoint, but cannot be removed once added. Keep in mind that each indexed field increases write latency and storage overhead, so only index fields you actively filter on.
Request to create a vector store.
A unique name for the vector store within the account
The embedding configuration. Either 'base' type with an embedding_model, or 'models_api' type with a model_deployment_id for custom models.
The base embedding model to use. Shorthand for embedding_config with type 'base'. Provide either embedding_config or embedding_model, not both.
sentence-transformers/all-MiniLM-L12-v2, sentence-transformers/all-mpnet-base-v2, sentence-transformers/multi-qa-distilbert-cos-v1, sentence-transformers/paraphrase-multilingual-mpnet-base-v2, openai/text-embedding-ada-002, openai/text-embedding-3-small, openai/text-embedding-3-large, embed-english-v3.0, embed-english-light-v3.0, embed-multilingual-v3.0, gemini/text-embedding-005, gemini/text-multilingual-embedding-002, gemini/gemini-embedding-001 Dimension size of embedding vectors. Required when neither 'embedding_config' nor 'embedding_model' is set. Automatically derived when an embedding model is provided.
Dictionary mapping metadata field names to their types for efficient filtering. Only STRING, NUMBER, and BOOLEAN types can be indexed.
Successful Response
Response model for vector store operations.
The name of the vector store
Dimensionality of the embedding vectors
Timestamp of creation
Timestamp of last update
Embedding configuration identifying the model and its type. None for raw-embedding-only stores.
Dictionary mapping metadata field names to their types