The context store model
The context store model contains metadata about your context stores, such as their key, name, and description. It also tracks when the store was created and last updated, and whether it’s currently active.Properties
integer
Unique identifier for the context store.
string
A URL-friendly unique key for the context store (lowercase letters, numbers, hyphens, underscores).
string
The display name of the context store.
string
An optional description of the context store’s purpose.
boolean
Whether or not the context store is active and can be used.
integer
The number of documents in this context store.
timestamp
Timestamp of when the context store was created.
timestamp
Timestamp of when the context store was last updated.
List all context stores
GET /v1/context
This endpoint allows you to retrieve a paginated list of all your context stores. By default, a maximum of 50 context stores are shown per page.
Optional parameters
integer
Maximum number of context stores to return (default: 50).
integer
Number of context stores to skip (default: 0).
boolean
Filter by active status.
string
Field to order by (default: “created_at”).
boolean
Order in descending order (default: true).
Response
Create a context store
POST /v1/context
This endpoint allows you to create a new context store. A context store acts as a container for context documents. The key must be URL-friendly (lowercase letters, numbers, hyphens, underscores).
Required attributes
string
required
A unique, URL-friendly key for the context store.
string
required
The display name for the context store.
Optional attributes
string
A description of the context store’s purpose.
string
The kind of content the store holds (one of
documents, translation_memory; default: documents). A translation_memory store holds bilingual TM segments (TMX) and requires retrieval_backend set to qdrant and an embedding_model.string
The retrieval backend to use (one of
none, qdrant; default: none).string
Embedding model identifier. Required when
retrieval_backend is qdrant.string
External index ID (Qdrant collection or OpenAI vector_store_id).
object
Optional chunking overrides. Object with
chunk_size and chunk_overlap.integer
ID of a prompt template that is automatically applied as the system prompt whenever a retriever is built from this store. The template must belong to the same organization or be a system default.
object
Parameters merged into template rendering (e.g.
{"instruments": "CRPD, Belgian Anti-Discrimination Act"}).Response
Retrieve a context store
GET /v1/context/:store_id
This endpoint allows you to retrieve a context store by providing its ID. Refer to the list at the top of this page to see which properties are included with context store objects.
Response
Update a context store
PUT /v1/context/:store_id
This endpoint allows you to perform an update on a context store. You can update the name, description, active status, and retrieval configuration.
Optional attributes
string
The display name for the context store.
string
A description of the context store.
boolean
Whether or not the context store is active.
string
The kind of content the store holds (one of
documents, translation_memory). Can only be changed while the store has no documents.string
The retrieval backend to use (one of
none, qdrant).string
Embedding model identifier. Required when
retrieval_backend is qdrant.string
External index ID (Qdrant collection or OpenAI vector_store_id).
object
Optional chunking overrides. Object with
chunk_size and chunk_overlap.integer
ID of a prompt template that is automatically applied as the system prompt whenever a retriever is built from this store. The template must belong to the same organization or be a system default.
object
Parameters merged into template rendering (e.g.
{"instruments": "CRPD, Belgian Anti-Discrimination Act"}).Response
Delete a context store
DELETE /v1/context/:store_id
This endpoint allows you to delete a context store. Note: This is a soft delete operation. By default, this will also delete all documents in the store and their associated S3 files.
Optional parameters
boolean
Whether to delete all documents in the store (default: true).
boolean
Whether to delete associated S3 files (default: true).
Reindex a context store
POST /v1/context/:store_id/reindex
This endpoint allows you to submit a rag_ingest job that (re)indexes every active document in the store. This is useful for backfilling after enabling a retrieval backend on an existing store, or for recovering from a worker crash that left documents stuck in processing. The response returns the workflow ID; poll the job status endpoint for progress.