Version 0.9.3

These docs are outdated. Read the latest.

REST API

Generated from the 0.9.3 OpenAPI specification.

Endpoints

GET /health Health check

Returns ready or degraded, plus the running version.

Status	Description	Type
`200`	Successful Response	object

GET /health/live Liveness check

Always succeeds while the process is running.

Status	Description	Type
`200`	Successful Response	object

GET /health/metrics Metrics snapshot

Counters, version, and hardware info as JSON. Requires the admin key when auth.mode=static.

Status	Description	Type
`200`	Successful Response	object

GET /health/ready Readiness check

Returns 503 until storage and embeddings are usable. Does not expose local filesystem paths.

Status	Description	Type
`200`	Successful Response	object

GET /metrics Prometheus metrics

The same counters in Prometheus exposition format. Requires the admin key when auth.mode=static.

Status	Description	Type
`200`	Successful Response	object

GET /v1/admin/archive Download an archive

Streams the whole dataset as a zip; requires the admin key.

Status	Description	Type
`200`	Successful Response
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`500`	Internal Server Error	ErrorResponse

PUT /v1/admin/archive Restore an archive

Overwrites current data with the uploaded zip; requires the admin key.

Request body (multipart/form-data): Body_restore_archive_v1_admin_archive_put

Status	Description	Type
`200`	Successful Response	RestoreArchiveResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`500`	Internal Server Error	ErrorResponse

POST /v1/admin/collections/{tenant}/{name}/move Rename a collection

Changes the slug, and therefore the URL; requires the admin key.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Request body (application/json): MoveCollectionBody

Status	Description	Type
`200`	Successful Response	MoveCollectionResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`409`	Conflict	ErrorResponse
`422`	Validation Error	HTTPValidationError
`500`	Internal Server Error	ErrorResponse

GET /v1/admin/embedders List embedder instances

Lists configured embedder instances and the resolved default; requires the admin key.

Status	Description	Type
`200`	Successful Response	EmbedderInventoryResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`500`	Internal Server Error	ErrorResponse

DELETE /v1/admin/metrics Reset metrics

Zeroes request counters; requires the admin key.

Status	Description	Type
`200`	Successful Response	ResetMetricsResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse

GET /v1/admin/queries/{query_id} Get any logged search

Finds a search by id without knowing its tenant; requires the admin key.

Parameter	In	Required	Type	Description
`query_id`	path	yes	string

Status	Description	Type
`200`	Successful Response	GetQueryLogResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`500`	Internal Server Error	ErrorResponse

POST /v1/admin/queries/{query_id}/replay Replay any logged search

Re-runs a search found by id in any tenant; requires the admin key.

Parameter	In	Required	Type	Description
`query_id`	path	yes	string

Status	Description	Type
`200`	Successful Response	QueryReplayResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

GET /v1/admin/tenants List tenants

Names every tenant on the instance; requires the admin key.

Status	Description	Type
`200`	Successful Response	ListTenantsResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant} List collections

One entry per collection, with display name and embedding model.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string

Status	Description	Type
`200`	Successful Response	ListCollectionsResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{collection}/chunks/{rid} Get a chunk

Returns the chunk's provenance and metadata, not its text.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`rid`	path	yes	string

Status	Description	Type
`200`	Successful Response	GetChunkResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{collection}/chunks/{rid}/content Get chunk content

Returns the chunk's raw text as the response body.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`rid`	path	yes	string

Status	Description	Type
`200`	Successful Response
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{collection}/documents List documents

One entry per document, with version and chunk count.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`collection`	path	yes	string

Status	Description	Type
`200`	Successful Response	ListDocumentsResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

POST /v1/collections/{tenant}/{collection}/documents Ingest a document

Chunks, embeds, and indexes a multipart file or JSON raw-text document; reusing a docid replaces it.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`csv_has_header`	query	no	string (optional)
`csv_meta_cols`	query	no	string (optional)
`csv_include_cols`	query	no	string (optional)

Request body (multipart/form-data): Body_ingest_document_v1_collections__tenant___collection__documents_post

Status	Description	Type
`201`	Successful Response	IngestDocumentResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`413`	Request Entity Too Large	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

DELETE /v1/collections/{tenant}/{collection}/documents/{docid} Delete a document

Removes the document and all chunks derived from it.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`docid`	path	yes	string

Status	Description	Type
`200`	Successful Response	DeleteDocumentResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{collection}/documents/{docid} Get a document

Includes stored metadata, version, and its chunk ids.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`docid`	path	yes	string

Status	Description	Type
`200`	Successful Response	GetDocumentResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{collection}/documents/{docid}/chunks List document chunks

Chunks in document order, with provenance metadata.

Parameter	In	Required	Type
`tenant`	path	yes	string
`collection`	path	yes	string
`docid`	path	yes	string

Status	Description	Type
`200`	Successful Response	ListChunksResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

POST /v1/collections/{tenant}/{collection}/documents:batch Ingest documents in a batch

Indexes several raw-text documents in one request. Each item may provide text, docid, and metadata.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`collection`	path	yes	string

Request body (application/json): BatchIngestDocumentsBody

Status	Description	Type
`201`	Successful Response	BatchIngestDocumentsResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`413`	Request Entity Too Large	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

DELETE /v1/collections/{tenant}/{name} Delete a collection

Permanently removes the collection and every document in it.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Status	Description	Type
`200`	Successful Response	DeleteCollectionResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

PATCH /v1/collections/{tenant}/{name} Update a collection

Changes editable metadata only; does not re-index documents.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Request body (application/json): UpdateCollectionBody

Status	Description	Type
`200`	Successful Response	UpdateCollectionResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

POST /v1/collections/{tenant}/{name} Create a collection

Optionally sets the display name and embedding model; returns 201.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Request body (application/json): CreateCollectionOptionsBody (optional)

Status	Description	Type
`201`	Successful Response	CreateCollectionResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

GET /v1/collections/{tenant}/{name}/detail Get collection detail

Settings plus document and chunk counts.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Status	Description	Type
`200`	Successful Response	CollectionDetailResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

POST /v1/collections/{tenant}/{name}/move Rename a collection

Changes the collection slug and therefore its URL.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Request body (application/json): MoveCollectionBody

Status	Description	Type
`200`	Successful Response	MoveCollectionResponse
`400`	Bad Request	ErrorResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`409`	Conflict	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{name}/queries List logged searches

Most recent first; omits result bodies, which one-by-id returns.

Parameter	In	Required	Type
`tenant`	path	yes	string
`name`	path	yes	string
`limit`	query	no	integer
`offset`	query	no	integer

Status	Description	Type
`200`	Successful Response	ListQueryLogsResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/collections/{tenant}/{name}/queries/{query_id} Get a logged search

Includes the query text, filters, and the chunk ids it returned.

Parameter	In	Required	Type
`tenant`	path	yes	string
`name`	path	yes	string
`query_id`	path	yes	string

Status	Description	Type
`200`	Successful Response	GetQueryLogResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

POST /v1/collections/{tenant}/{name}/queries/{query_id}/replay Replay a logged search

Re-runs the original query against current data; recorded as a new entry.

Parameter	In	Required	Type
`tenant`	path	yes	string
`name`	path	yes	string
`query_id`	path	yes	string

Status	Description	Type
`200`	Successful Response	QueryReplayResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`404`	Not Found	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

GET /v1/collections/{tenant}/{name}/search Search a collection

Query-string form of the search; metadata filters are not accepted.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string
`q`	query	yes	string
`k`	query	no	integer
`include_common`	query	no	boolean	Include configured common collection results when server common search is enabled.

Status	Description	Type
`200`	Successful Response	SearchResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

POST /v1/collections/{tenant}/{name}/search Search a collection

Ranked semantic matches with provenance and per-phase timing.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string
`name`	path	yes	string

Request body (application/json): SearchBody

Status	Description	Type
`200`	Successful Response	SearchResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

GET /v1/embedders/{tenant} List embedders available to a tenant

Lists configured embedder instances currently available in this tenant namespace.

Parameter	In	Required	Type	Description
`tenant`	path	yes	string

Status	Description	Type
`200`	Successful Response	EmbedderInventoryResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`429`	Too Many Requests	ErrorResponse
`500`	Internal Server Error	ErrorResponse

GET /v1/search Search shared collections

Query-string form of the shared search; filters are not accepted.

Parameter	In	Required	Type	Description
`q`	query	yes	string
`k`	query	no	integer

Status	Description	Type
`200`	Successful Response	SearchResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

POST /v1/search Search shared collections

Searches the shared scope; empty when that scope is disabled.

Request body (application/json): SearchBody

Status	Description	Type
`200`	Successful Response	SearchResponse
`401`	Unauthorized	ErrorResponse
`403`	Forbidden	ErrorResponse
`422`	Validation Error	HTTPValidationError
`500`	Internal Server Error	ErrorResponse
`503`	Service Unavailable	ErrorResponse

Schemas

BatchDocumentInput

One raw-text or raw-vector document in a batch ingest request.

Property	Type	Required	Description
`docid`	string (optional)	no	Optional stable document id; generated when omitted.
`metadata`	object (optional)	no	Optional user metadata stored with the document.
`text`	string (optional)	no	Raw text to index as one document.
`vector`	array of number (optional)	no	Raw embedding vector (BYOV). Provide exactly one of text or vector.

BatchIngestDocumentResult

Per-document result for batch ingest.

Property	Type	Required	Description
`chunks`	integer (optional)	no	Number of chunks indexed on success.
`code`	string (optional)	no	Failure code for this item.
`docid`	string (optional)	no	Document id, when known.
`error`	string (optional)	no	Failure message for this item.
`index`	integer	yes	Zero-based item index.
`ok`	boolean	yes	Whether this document was ingested.

BatchIngestDocumentsBody

Batch raw-text document ingest request.

Property	Type	Required	Description
`documents`	array of BatchDocumentInput	yes	Documents to ingest.

BatchIngestDocumentsResponse

Result of ingesting several raw-text documents.

Property	Type	Required	Description
`collection`	string	yes	Collection scope.
`count`	integer	yes	Number of items processed.
`documents`	array of BatchIngestDocumentResult	yes	Per-document ingest results.
`failed`	integer	yes	Number of failed items.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`succeeded`	integer	yes	Number of successful items.
`tenant`	string	yes	Tenant scope.

Body_ingest_document_v1_collectionstenant_collection__documents_post

Property	Type	Required
`docid`	string (optional)	no
`file`	string (optional)	no
`metadata`	string (optional)	no

Body_restore_archive_v1_admin_archive_put

Property	Type	Required	Description
`file`	string	yes

ChunkSummary

Compact entry for chunk listings.

Property	Type	Required	Description
`chunk_path`	string (optional)	no	Position of the chunk within the document.
`ingested_at`	string	yes	When the chunk was ingested (ISO 8601).
`meta`	object	yes	Provenance and user metadata for the chunk.
`rid`	string	yes	Chunk id.

CollectionDetailResponse

Full detail for one collection.

Property	Type	Required	Description
`chunk_count`	integer	yes	Number of chunks.
`created_at`	string (optional)	no	When the collection was created (ISO 8601).
`display_name`	string (optional)	no	Human-friendly label.
`doc_count`	integer	yes	Number of documents.
`embed_model`	string (optional)	no	Embedding model name.
`embedder_config`	object	no	Extra embedding options.
`embedder_type`	string (optional)	no	Embedding backend in use.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`name`	string	yes	Collection slug.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the collection.
`vector_space_key`	string (optional)	no	Identifier for the embedding model and any space-affecting config shared by this collection's vectors.

CollectionSummary

Compact entry for collection listings.

Property	Type	Required	Description
`display_name`	string (optional)	no	Human-friendly label.
`embedder_label`	string (optional)	no	Embedding backend and model in one label.
`name`	string	yes	Collection slug.
`vector_space_key`	string (optional)	no	Identifier for the embedding model and any space-affecting config shared by this collection's vectors.

CreateCollectionOptionsBody

Optional settings when creating a collection.

Property	Type	Required	Description
`display_name`	string (optional)	no	Human-friendly label for the collection.
`embed_model`	string (optional)	no	Embedding model name.
`embedder_config`	object (optional)	no	Extra embedding options.
`embedder_type`	string (optional)	no	Embedding backend to use for this collection.

CreateCollectionResponse

A newly created collection.

Property	Type	Required	Description
`collection`	string	yes	Collection slug.
`display_name`	string	yes	Human-friendly label.
`embed_model`	string	yes	Embedding model name.
`embedder_config`	object	no	Extra embedding options.
`embedder_type`	string	yes	Embedding backend in use.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`name`	string	yes	Collection slug.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the collection.

DefaultEmbedderInventory

Default embedder resolution.

Property	Type	Required	Description
`instance_keys`	array of string	yes	Instance keys in the default routing pool.
`selector`	string (optional)	no	Configured embedder.default selector, if any.
`vector_key`	string	yes	Default vector-space key.

DeleteCollectionResponse

Confirmation of a deleted collection.

Property	Type	Required	Description
`deleted`	string	yes	Slug of the deleted collection.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owned the collection.

DeleteDocumentResponse

Confirmation of a deleted document.

Property	Type	Required	Description
`chunks_deleted`	integer	yes	Number of chunks removed.
`collection`	string	yes	Collection it was in.
`docid`	string	yes	Id of the deleted document.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owned the document.

DocumentSummary

Compact entry for document listings.

Property	Type	Required	Description
`chunk_count`	integer	yes	Number of chunks.
`docid`	string	yes	Document id.
`ingested_at`	string	yes	When the document was last ingested (ISO 8601).
`version`	integer	yes	Revision, incremented on re-ingest.

EmbedderInventoryEntry

A configured embedder instance exposed without credentials.

Property	Type	Required	Description
`embed_model`	string	yes	Embedding model name.
`embedder_type`	string	yes	Embedder implementation type.
`key`	string	yes	Configured embedder instance key.
`vector_key`	string	yes	Vector-space key produced by this instance.

EmbedderInventoryResponse

Configured embedder instances available to a caller.

Property	Type	Required	Description
`count`	integer	yes	Number of configured instances.
`default`	DefaultEmbedderInventory	yes	Resolved default embedder.
`embedders`	array of EmbedderInventoryEntry	yes	Configured embedder instances.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string (optional)	no	Tenant scope for tenant-namespaced requests.

ErrorResponse

API error envelope.

Property	Type	Required	Description
`code`	string	yes	Stable, machine-readable error code.
`details`	object (optional)	no	Optional structured context about the error.
`error`	string	yes	Human-readable error message.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	yes	Always false on an error response.
`request_id`	string (optional)	no	Correlation id echoed for this request.

GetChunkResponse

Detail for one chunk.

Property	Type	Required	Description
`chunk_path`	string (optional)	no	Position of the chunk within the document.
`collection`	string	yes	Collection it belongs to.
`docid`	string	yes	Document it belongs to.
`ingested_at`	string	yes	When the chunk was ingested (ISO 8601).
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`meta`	object	yes	Provenance and user metadata for the chunk.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`rid`	string	yes	Chunk id.
`tenant`	string	yes	Tenant that owns the chunk.

GetDocumentResponse

Detail for one document.

Property	Type	Required	Description
`chunk_count`	integer	yes	Number of chunks.
`chunk_ids`	array of string	yes	Chunk ids that make up the document.
`collection`	string	yes	Collection it belongs to.
`docid`	string	yes	Document id.
`ingested_at`	string	yes	When the document was last ingested (ISO 8601).
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`metadata`	object	yes	User metadata stored with the document.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the document.
`version`	integer	yes	Revision, incremented on re-ingest.

GetQueryLogResponse

A single logged search.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`query`	QueryLogEntry	yes	The logged search and its results.
`request_id`	string (optional)	no	Correlation id echoed for this request.

HTTPValidationError

Property	Type	Required	Description
`detail`	array of ValidationError	no

IngestDocumentResponse

Result of ingesting a document.

Property	Type	Required	Description
`chunks`	integer	yes	Number of chunks created.
`collection`	string	yes	Collection the document went into.
`docid`	string	yes	Id of the ingested document.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the document.

ListChunksResponse

All chunks of a document.

Property	Type	Required	Description
`chunks`	array of ChunkSummary	yes	The chunks.
`collection`	string	yes	Collection scope.
`count`	integer	yes	Number of chunks.
`docid`	string	yes	Document the chunks belong to.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant scope of the listing.

ListCollectionsResponse

All collections in a tenant.

Property	Type	Required	Description
`collections`	array of CollectionSummary	yes	The collections.
`count`	integer	yes	Number of collections.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant scope of the listing.

ListDocumentsResponse

All documents in a collection.

Property	Type	Required	Description
`collection`	string	yes	Collection scope.
`count`	integer	yes	Number of documents.
`documents`	array of DocumentSummary	yes	The documents.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant scope of the listing.

ListQueryLogsResponse

A page of logged searches.

Property	Type	Required	Description
`collection`	string (optional)	no	Collection scope, if narrowed.
`count`	integer	yes	Number of entries returned.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`queries`	array of QueryLogSummary	yes	The logged searches.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant scope of the listing.

ListTenantsResponse

All known tenants.

Property	Type	Required	Description
`count`	integer	yes	Number of tenants.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenants`	array of string	yes	Tenant slugs.

MoveCollectionBody

Request body for renaming a collection.

Property	Type	Required	Description
`new_name`	string	yes	New collection slug.

MoveCollectionResponse

Confirmation of a renamed collection.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`new_name`	string	yes	New collection slug.
`ok`	boolean	no	Always true on a success response.
`old_name`	string	yes	Previous collection slug.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the collection.

QueryLogEntry

A recorded search and its results.

Property	Type	Required	Description
`actor`	string	yes	Who ran the search.
`collection`	string	yes	Collection searched.
`common_collection`	string (optional)	no	The included common collection, if any.
`common_tenant`	string (optional)	no	Tenant of the included common collection, if any.
`executed_at`	string	yes	When the search ran (ISO 8601).
`filters`	object (optional)	no	Metadata filters applied to the search.
`include_common`	boolean	no	Whether common results were included.
`k`	integer	yes	Maximum number of hits requested.
`latency_ms`	number (optional)	no	Total time for the search, in ms.
`query_id`	string	yes	Id of the logged search.
`query_text`	string	yes	The search text.
`replay_of`	string (optional)	no	Original query id when this entry is a replay.
`request_id`	string (optional)	no	Correlation id of the original request.
`result_count`	integer	yes	Number of hits returned.
`result_ids`	array of string	yes	Chunk ids returned, in rank order.
`tenant`	string	yes	Tenant the search ran in.
`timing`	object (optional)	no	Per-phase latency breakdown, in ms.

QueryLogSummary

Compact entry for query-log listings.

Property	Type	Required	Description
`executed_at`	string	yes	When the search ran (ISO 8601).
`k`	integer	yes	Maximum number of hits requested.
`latency_ms`	number (optional)	no	Total time for the search, in ms.
`query_id`	string	yes	Id of the logged search.
`query_text`	string	yes	The search text.
`replay_of`	string (optional)	no	Original query id when this entry is a replay.
`request_id`	string (optional)	no	Correlation id of the original request.
`result_count`	integer	yes	Number of hits returned.

QueryReplayResponse

Results of re-running a logged search.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`matches`	array of SearchResult	yes	Hits from the replay.
`ok`	boolean	no	Always true on a success response.
`original_latency_ms`	number (optional)	no	Latency of the original search, in ms.
`original_query_id`	string	yes	Id of the search that was replayed.
`original_result_count`	integer	yes	Hit count of the original search.
`replay_query_id`	string (optional)	no	Id assigned to this replay. Omitted when query logging is disabled.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`timing`	SearchTiming (optional)	no	Per-phase latency breakdown.

ResetMetricsResponse

Confirmation that metrics were reset.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`reset_at`	number	yes	When metrics were reset (Unix seconds).

RestoreArchiveResponse

Confirmation of a restored archive.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.

SearchBody

Search request body.

Property	Type	Required	Description
`filters`	object (optional)	no	Metadata equality filters to narrow results.
`include_common`	boolean	no	Include configured common collection results when server common search is enabled.
`k`	integer	no	Maximum number of hits.
`q`	string (optional)	no	The search text.
`v`	array of number (optional)	no	Raw query vector (BYOV). Provide exactly one of q or v.

SearchResponse

Search results with optional timing.

Property	Type	Required	Description
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`matches`	array of SearchResult	yes	Ranked list of hits, best first.
`ok`	boolean	no	Always true on a success response.
`query_id`	string (optional)	no	Id for this search, usable with the /queries/{query_id} and /queries/{query_id}/replay endpoints. Omitted when query logging is disabled.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`timing`	SearchTiming (optional)	no	Per-phase latency breakdown.

SearchResult

A single search hit.

Property	Type	Required	Description
`collection`	string	yes	Collection the hit came from.
`id`	string	yes	Chunk id of the matching passage.
`match_reason`	string	yes	Why this result matched.
`meta`	object	yes	Provenance and user metadata for the chunk.
`score`	number	yes	Relevance score; higher is closer.
`tenant`	string	yes	Tenant that owns the hit.
`text`	string (optional)	yes	The matched snippet, when stored.

SearchTiming

Per-phase latency breakdown, in ms.

Property	Type	Required	Description
`embed_ms`	number	yes	Time to turn the query into a vector.
`filter_ms`	number	yes	Time spent applying metadata filters.
`hydrate_ms`	number	yes	Time spent loading snippet text and metadata.
`search_ms`	number	yes	Time spent finding nearest matches.

UpdateCollectionBody

Request body for editing collection metadata.

Property	Type	Required	Description
`display_name`	string	yes	New human-friendly label.

UpdateCollectionResponse

Confirmation of updated collection metadata.

Property	Type	Required	Description
`display_name`	string	yes	Updated label.
`latency_ms`	number (optional)	no	Total server-side time for this request, in ms.
`name`	string	yes	Collection slug.
`ok`	boolean	no	Always true on a success response.
`request_id`	string (optional)	no	Correlation id echoed for this request.
`tenant`	string	yes	Tenant that owns the collection.

ValidationError

Property	Type	Required
`ctx`	object	no
`input`	object	no
`loc`	array of string, integer (optional)	yes
`msg`	string	yes
`type`	string	yes