REST API Generated from the 0.9.7
OpenAPI specification .
Endpoints GET
/health
Health check Returns ready or degraded, plus the running version.
Status Description Type 200Successful Response object
GET
/health/live
Liveness check Always succeeds while the process is running.
Status Description Type 200Successful 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 200Successful Response object
GET
/health/ready
Readiness check Returns 503 until storage and embeddings are usable. Does not expose local filesystem paths.
Status Description Type 200Successful Response object
GET
/metrics
Prometheus metrics The same counters in Prometheus exposition format. Requires the admin key when auth.mode=static.
Status Description Type 200Successful Response object
GET
/v1/admin/archive
Download an archive Streams the whole dataset as a zip; requires the admin key. Collections that fail validation are left out and named in the X-PaveDB-Skipped-Collections header.
PUT
/v1/admin/archive
Restore an archive Overwrites current data with the uploaded zip. The admin key is checked before body consumption; general request and document size limits do not apply.
Request body (multipart/form-data): Body_restore_archive_v1_admin_archive_put
GET
/v1/admin/collections/{tenant}/{name}/archive
Download a collection archive Streams one collection and its portable manifest as a zip; requires the admin key.
Parameter In Required Type Description tenantpath yes string namepath yes string
POST
/v1/admin/collections/{tenant}/{name}/archive
Restore a collection archive as a new collection Creates the collection from a same-version archive after local embedder preflight; an existing collection is refused. Requires the admin key.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (multipart/form-data): Body_restore_collection_archive_v1_admin_collections__tenant___name__archive_post
PUT
/v1/admin/collections/{tenant}/{name}/archive
Replace a collection from an archive Replaces an existing collection from a same-version archive after local embedder preflight; a missing collection is refused. Requires the admin key.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (multipart/form-data): Body_restore_collection_archive_v1_admin_collections__tenant___name__archive_put
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 tenantpath yes string namepath yes string
Request body (application/json): MoveCollectionBody
POST
/v1/admin/collections/{tenant}/{name}/reindex
Reindex a collection Starts an interruptible, resumable vector rebuild against a new embedder specification; requires the admin key.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): ReindexCollectionBody
GET
/v1/admin/embedders
List embedder instances Lists configured embedder instances and the resolved default; requires the admin key.
DELETE
/v1/admin/metrics
Reset metrics Zeroes request counters; requires the admin key.
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_idpath yes string
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_idpath yes string
DELETE
/v1/admin/reindex/{job_id}
Cancel a reindex job Discards staged vectors without changing the live index; requires the admin key.
Parameter In Required Type Description job_idpath yes string
GET
/v1/admin/reindex/{job_id}
Get reindex job status Returns durable reindex progress; requires the admin key.
Parameter In Required Type Description job_idpath yes string
POST
/v1/admin/reindex/{job_id}/pause
Pause a reindex job Requests a pause after the current persisted batch; requires the admin key.
Parameter In Required Type Description job_idpath yes string
POST
/v1/admin/reindex/{job_id}/resume
Resume a reindex job Resumes from persisted batches; requires the admin key.
Parameter In Required Type Description job_idpath yes string
GET
/v1/admin/tenants
List tenants Names every tenant on the instance; requires the admin key.
GET
/v1/collections/{tenant}
List collections One entry per collection, with display name and embedding model.
Parameter In Required Type Description tenantpath yes string
GET
/v1/collections/{tenant}/{collection}/chunks/{rid}
Get a chunk Returns the chunk's provenance and metadata, not its text.
Parameter In Required Type Description tenantpath yes string collectionpath yes string ridpath yes string
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 Description tenantpath yes string collectionpath yes string ridpath yes string
GET
/v1/collections/{tenant}/{collection}/documents
List documents One entry per document, with version and chunk count.
Parameter In Required Type Description tenantpath yes string collectionpath yes string
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 Description tenantpath yes string collectionpath yes string csv_has_headerquery no string (optional) csv_meta_colsquery no string (optional) csv_include_colsquery no string (optional)
Request body (multipart/form-data): Body_ingest_document_v1_collections__tenant___collection__documents_post
DELETE
/v1/collections/{tenant}/{collection}/documents/{docid}
Delete a document Removes the document and all chunks derived from it.
Parameter In Required Type Description tenantpath yes string collectionpath yes string docidpath yes string
GET
/v1/collections/{tenant}/{collection}/documents/{docid}
Get a document Includes stored metadata, version, and its chunk ids.
Parameter In Required Type Description tenantpath yes string collectionpath yes string docidpath yes string
GET
/v1/collections/{tenant}/{collection}/documents/{docid}/chunks
List document chunks Chunks in document order, with provenance metadata.
Parameter In Required Type Description tenantpath yes string collectionpath yes string docidpath yes string
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 tenantpath yes string collectionpath yes string
Request body (application/json): BatchIngestDocumentsBody
DELETE
/v1/collections/{tenant}/{name}
Delete a collection Permanently removes the collection and every document in it.
Parameter In Required Type Description tenantpath yes string namepath yes string
PATCH
/v1/collections/{tenant}/{name}
Update a collection Changes editable metadata only; does not re-index documents.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): UpdateCollectionBody
POST
/v1/collections/{tenant}/{name}
Create a collection Optionally sets the display name and selects an embedder by shorthand or detailed fields; returns 201.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): CreateCollectionOptionsBody (optional)
GET
/v1/collections/{tenant}/{name}/archive
Download this collection as a portable archive Streams the collection and its manifest as a zip — the same portable format the admin archive uses, scoped to your own tenant. Restore it into any PaveDB of the same version.
Parameter In Required Type Description tenantpath yes string namepath yes string
POST
/v1/collections/{tenant}/{name}/archive
Restore a portable archive as a new collection Creates the collection from a same-version archive after embedder preflight, scoped to your own tenant; an existing collection is refused.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (multipart/form-data): Body_restore_own_collection_archive_v1_collections__tenant___name__archive_post
PUT
/v1/collections/{tenant}/{name}/archive
Replace this collection from a portable archive Replaces an existing collection from a same-version archive after embedder preflight, scoped to your own tenant; a missing collection is refused.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (multipart/form-data): Body_restore_own_collection_archive_v1_collections__tenant___name__archive_put
GET
/v1/collections/{tenant}/{name}/detail
Get collection detail Settings plus document and chunk counts.
Parameter In Required Type Description tenantpath yes string namepath yes string
POST
/v1/collections/{tenant}/{name}/move
Rename a collection Changes the collection slug and therefore its URL.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): MoveCollectionBody
GET
/v1/collections/{tenant}/{name}/queries
List logged searches Most recent first; omits result bodies, which one-by-id returns.
Parameter In Required Type Description tenantpath yes string namepath yes string limitquery no integer offsetquery no integer
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 Description tenantpath yes string namepath yes string query_idpath yes string
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 Description tenantpath yes string namepath yes string query_idpath yes string
POST
/v1/collections/{tenant}/{name}/reindex
Rebuild this collection in a new vector space Starts a resumable reindex job that re-embeds the collection into the requested embedder space (same rules as create). Operator routing decides which instance executes the embeds.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): ReindexCollectionBody
DELETE
/v1/collections/{tenant}/{name}/reindex/{job_id}
Cancel this collection's reindex job Stops the job and keeps the collection serving from its current index; jobs from other tenants or collections answer 404.
Parameter In Required Type Description tenantpath yes string namepath yes string job_idpath yes string
GET
/v1/collections/{tenant}/{name}/reindex/{job_id}
Inspect this collection's reindex job Progress and state of a reindex job started on this collection; jobs from other tenants or collections answer 404.
Parameter In Required Type Description tenantpath yes string namepath yes string job_idpath yes string
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 tenantpath yes string namepath yes string qquery yes string kquery no integer modequery no string (optional) include_commonquery no boolean Include configured common collection results when server common search is enabled.
POST
/v1/collections/{tenant}/{name}/search
Search a collection Ranked retrieval matches with provenance and per-phase timing.
Parameter In Required Type Description tenantpath yes string namepath yes string
Request body (application/json): SearchBody
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 tenantpath yes string
GET
/v1/search
Search shared collections Query-string form of the shared search; filters are not accepted.
Parameter In Required Type Description qquery yes string kquery no integer modequery no string (optional)
POST
/v1/search
Search shared collections Searches the shared scope by text; empty when that scope is disabled.
Request body (application/json): SearchBody
Schemas BatchIngestDocumentResult Per-document result for batch ingest.
Property Type Required Description chunksinteger (optional) no Number of chunks indexed on success. codestring (optional) no Failure code for this item. docidstring (optional) no Document id, when known. errorstring (optional) no Failure message for this item. indexinteger yes Zero-based item index. okboolean yes Whether this document was ingested.
BatchIngestDocumentsBody Batch raw-text document ingest request.
Property Type Required Description documentsarray of BatchDocumentInput yes Documents to ingest.
BatchIngestDocumentsResponse Result of ingesting several raw-text documents.
Property Type Required Description collectionstring yes Collection scope. countinteger yes Number of items processed. documentsarray of BatchIngestDocumentResult yes Per-document ingest results. failedinteger yes Number of failed items. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. succeededinteger yes Number of successful items. tenantstring yes Tenant scope.
Body_ingest_document_v1_collections__tenant___collection__documents_post Property Type Required Description docidstring (optional) no filestring (optional) no metadatastring (optional) no
Body_restore_archive_v1_admin_archive_put Property Type Required Description filestring yes
Body_restore_collection_archive_v1_admin_collections__tenant___name__archive_post Property Type Required Description filestring yes
Body_restore_collection_archive_v1_admin_collections__tenant___name__archive_put Property Type Required Description filestring yes
Body_restore_own_collection_archive_v1_collections__tenant___name__archive_post Property Type Required Description filestring yes
Body_restore_own_collection_archive_v1_collections__tenant___name__archive_put Property Type Required Description filestring yes
ChunkSummary Compact entry for chunk listings.
Property Type Required Description chunk_pathstring (optional) no Position of the chunk within the document. ingested_atstring yes When the chunk was ingested (ISO 8601). metaobject yes Provenance and user metadata for the chunk. ridstring yes Chunk id.
ChunkingSpec How a collection cuts free text into chunks; fixed at creation.
Property Type Required Description overlapinteger (optional) no fixed only: characters shared with the previous chunk; at most a quarter of size. Omitted, the default. sizeinteger (optional) no fixed only: characters per chunk; omitted, the default. strategystring (optional) no fixed: overlapping windows of characters. none: each text is one chunk. Omitted: the instance default.
CollectionDetailResponse Full detail for one collection.
Property Type Required Description chunk_countinteger yes Number of chunks. chunkingobject (optional) no Chunking the collection applies to free text. created_atstring (optional) no When the collection was created (ISO 8601). display_namestring (optional) no Human-friendly label. doc_countinteger yes Number of documents. embed_modelstring (optional) no Embedding model name. embedder_configobject no Extra embedding options. embedder_typestring (optional) no Embedding backend in use. latency_msnumber (optional) no Total server-side time for this request, in ms. namestring yes Collection slug. okboolean no Always true on a success response. pavedb_versionstring (optional) no PaveDB version that created the collection; unset for collections that predate this tag (P2-25). priority_keystring no Metadata field that boosts search scores. request_idstring (optional) no Correlation id echoed for this request. schema_versioninteger (optional) no Per-collection metadata schema version at creation time; unset for collections that predate this tag (P2-25). search_modestring no Default ranking mode for searches that name none. tenantstring yes Tenant that owns the collection. vector_space_keystring (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_namestring (optional) no Human-friendly label. embedder_labelstring (optional) no Embedding backend and model in one label. namestring yes Collection slug. vector_space_keystring (optional) no Identifier for the embedding model and any space-affecting config shared by this collection's vectors.
ContentFilter One additive chunk-text predicate for a search.
Property Type Required Description opstring yes Text matching operation. valuestring yes Non-empty text value to match against stored chunks.
CreateCollectionOptionsBody Optional settings when creating a collection.
Property Type Required Description chunkingChunkingSpec (optional)no Chunking for free text, fixed at creation and checked against the instance's bounds. Omitted: the instance default. display_namestring (optional) no Human-friendly label for the collection. embed_modelstring (optional) no Embedding model name. embedderstring (optional) no Configured embedder selector shorthand: instance key, type, type:model, or full vector-space key. Cannot be combined with the detailed embedder fields. embedder_configobject (optional) no Extra embedding options. embedder_typestring (optional) no Embedding backend to use for this collection. priority_keystring (optional) no Metadata field whose numeric value, clamped to [-1, 1], scales each hit's score by (1 + value). Fixed at creation. Omitted: prio_boost. search_modestring (optional) no Default ranking mode for searches that name none; fixed at creation. Must be a mode the instance serves. Defaults to vector.
CreateCollectionResponse A newly created collection.
Property Type Required Description chunkingobject (optional) no Chunking the collection applies to free text. collectionstring yes Collection slug. display_namestring yes Human-friendly label. embed_modelstring yes Embedding model name. embedder_configobject no Extra embedding options. embedder_typestring yes Embedding backend in use. latency_msnumber (optional) no Total server-side time for this request, in ms. namestring yes Collection slug. okboolean no Always true on a success response. priority_keystring no Metadata field that boosts search scores. request_idstring (optional) no Correlation id echoed for this request. search_modestring no Default ranking mode for searches that name none. tenantstring yes Tenant that owns the collection.
DefaultEmbedderInventory Default embedder resolution.
Property Type Required Description instance_keysarray of string yes Instance keys in the default routing pool. selectorstring (optional) no Configured embedder.default selector, if any. vector_keystring yes Default vector-space key.
DeleteCollectionResponse Confirmation of a deleted collection.
Property Type Required Description deletedstring yes Slug of the deleted collection. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owned the collection.
DeleteDocumentResponse Confirmation of a deleted document.
Property Type Required Description chunks_deletedinteger yes Number of chunks removed. collectionstring yes Collection it was in. docidstring yes Id of the deleted document. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owned the document.
DocumentSummary Compact entry for document listings.
Property Type Required Description chunk_countinteger yes Number of chunks. docidstring yes Document id. ingested_atstring yes When the document was last ingested (ISO 8601). versioninteger yes Revision, incremented on re-ingest.
EmbedderInventoryEntry A configured embedder instance exposed without credentials.
Property Type Required Description embed_modelstring yes Embedding model name. embedder_typestring yes Embedder implementation type. keystring yes Configured embedder instance key. vector_keystring yes Vector-space key produced by this instance.
EmbedderInventoryResponse Configured embedder instances available to a caller.
Property Type Required Description countinteger yes Number of configured instances. defaultDefaultEmbedderInventory yes Resolved default embedder. embeddersarray of EmbedderInventoryEntry yes Configured embedder instances. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring (optional) no Tenant scope for tenant-namespaced requests.
ErrorResponse API error envelope.
Property Type Required Description codestring yes Stable, machine-readable error code. detailsobject (optional) no Optional structured context about the error. errorstring yes Human-readable error message. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean yes Always false on an error response. request_idstring (optional) no Correlation id echoed for this request.
GetChunkResponse Detail for one chunk.
Property Type Required Description chunk_pathstring (optional) no Position of the chunk within the document. collectionstring yes Collection it belongs to. docidstring yes Document it belongs to. ingested_atstring yes When the chunk was ingested (ISO 8601). latency_msnumber (optional) no Total server-side time for this request, in ms. metaobject yes Provenance and user metadata for the chunk. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. ridstring yes Chunk id. tenantstring yes Tenant that owns the chunk.
GetDocumentResponse Detail for one document.
Property Type Required Description chunk_countinteger yes Number of chunks. chunk_idsarray of string yes Chunk ids that make up the document. collectionstring yes Collection it belongs to. docidstring yes Document id. ingested_atstring yes When the document was last ingested (ISO 8601). latency_msnumber (optional) no Total server-side time for this request, in ms. metadataobject yes User metadata stored with the document. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owns the document. versioninteger yes Revision, incremented on re-ingest.
GetQueryLogResponse A single logged search.
Property Type Required Description latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. queryQueryLogEntry yes The logged search and its results. request_idstring (optional) no Correlation id echoed for this request.
IngestDocumentResponse Result of ingesting a document.
Property Type Required Description chunksinteger yes Number of chunks created. collectionstring yes Collection the document went into. docidstring yes Id of the ingested document. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owns the document.
ListChunksResponse All chunks of a document.
Property Type Required Description chunksarray of ChunkSummary yes The chunks. collectionstring yes Collection scope. countinteger yes Number of chunks. docidstring yes Document the chunks belong to. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant scope of the listing.
ListCollectionsResponse All collections in a tenant.
Property Type Required Description collectionsarray of CollectionSummary yes The collections. countinteger yes Number of collections. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant scope of the listing.
ListDocumentsResponse All documents in a collection.
Property Type Required Description collectionstring yes Collection scope. countinteger yes Number of documents. documentsarray of DocumentSummary yes The documents. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant scope of the listing.
ListQueryLogsResponse A page of logged searches.
Property Type Required Description collectionstring (optional) no Collection scope, if narrowed. countinteger yes Number of entries returned. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. queriesarray of QueryLogSummary yes The logged searches. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant scope of the listing.
ListTenantsResponse All known tenants.
Property Type Required Description countinteger yes Number of tenants. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantsarray of string yes Tenant slugs.
MoveCollectionBody Request body for renaming a collection.
Property Type Required Description new_namestring yes New collection slug.
MoveCollectionResponse Confirmation of a renamed collection.
Property Type Required Description latency_msnumber (optional) no Total server-side time for this request, in ms. new_namestring yes New collection slug. okboolean no Always true on a success response. old_namestring yes Previous collection slug. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owns the collection.
QueryLogEntry A recorded search and its results.
Property Type Required Description actorstring yes Who ran the search. collectionstring yes Collection searched. common_collectionstring (optional) no The included common collection, if any. common_tenantstring (optional) no Tenant of the included common collection, if any. content_filterContentFilter (optional)no Chunk-text predicate applied to the search. executed_atstring yes When the search ran (ISO 8601). filtersobject (optional) no Metadata filters applied to the search. include_commonboolean no Whether common results were included. kinteger yes Maximum number of hits requested. latency_msnumber (optional) no Total time for the search, in ms. modestring no Ranking mode the search ran with. query_idstring yes Id of the logged search. query_textstring yes The search text. replay_ofstring (optional) no Original query id when this entry is a replay. request_idstring (optional) no Correlation id of the original request. result_countinteger yes Number of hits returned. result_idsarray of string yes Chunk ids returned, in rank order. tenantstring yes Tenant the search ran in. timingobject (optional) no Per-phase latency breakdown, in ms.
QueryLogSummary Compact entry for query-log listings.
Property Type Required Description executed_atstring yes When the search ran (ISO 8601). kinteger yes Maximum number of hits requested. latency_msnumber (optional) no Total time for the search, in ms. query_idstring yes Id of the logged search. query_textstring yes The search text. replay_ofstring (optional) no Original query id when this entry is a replay. request_idstring (optional) no Correlation id of the original request. result_countinteger yes Number of hits returned.
QueryReplayResponse Results of re-running a logged search.
Property Type Required Description latency_msnumber (optional) no Total server-side time for this request, in ms. matchesarray of SearchResult yes Hits from the replay. modestring (optional) no Mode the replay ran with: the one the original logged. okboolean no Always true on a success response. original_latency_msnumber (optional) no Latency of the original search, in ms. original_query_idstring yes Id of the search that was replayed. original_result_countinteger yes Hit count of the original search. replay_query_idstring (optional) no Id assigned to this replay. Omitted when query logging is disabled. request_idstring (optional) no Correlation id echoed for this request. timingSearchTiming (optional)no Per-phase latency breakdown.
ReindexCollectionBody New embedder vector space for a collection reindex job.
Property Type Required Description embed_modelstring (optional) no Embedding model to use for the rebuilt index. embedder_configobject (optional) no Space-affecting options for the target embedder. embedder_typestring (optional) no Embedding backend to use for the rebuilt index.
ReindexJobResponse Durable status and progress for one collection reindex job.
Property Type Required Description collectionstring yes Collection slug being reindexed. completed_chunksinteger yes Chunks reindexed so far. created_atstring yes When the job was created (ISO 8601). errorstring (optional) no Failure detail when the job status is failed. finished_atstring (optional) no When the job reached a terminal state (ISO 8601), or null. job_idstring yes Stable job identifier. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. started_atstring (optional) no When the job began running (ISO 8601), or null. statusstring yes Current lifecycle state of the reindex job. targetReindexTarget yes Vector space the job rebuilds the collection into. tenantstring yes Tenant that owns the collection. total_chunksinteger yes Total chunks the job will reindex. updated_atstring yes When the job last advanced (ISO 8601).
ReindexTarget Persistable target vector-space identity for a reindex job.
Property Type Required Description embed_modelstring yes Embedding model the rebuilt index uses. embedder_configobject no Space-affecting options for the target embedder. embedder_typestring yes Embedding backend the job rebuilds the index with.
ResetMetricsResponse Confirmation that metrics were reset.
Property Type Required Description latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. reset_atnumber yes When metrics were reset (Unix seconds).
RestoreArchiveResponse Confirmation of a restored archive.
Property Type Required Description latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request.
RestoreCollectionArchiveResponse Confirmation of a restored collection archive.
Property Type Required Description collectionstring yes Destination collection slug. latency_msnumber (optional) no Total server-side time for this request, in ms. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Destination tenant.
SearchBody Search request body.
Property Type Required Description content_filterContentFilter (optional)no Additive exact, phrase, token-prefix, or substring predicate over stored chunk text. filtersobject (optional) no Metadata equality filters to narrow results. include_commonboolean no Include configured common collection results when server common search is enabled. kinteger no Maximum number of hits. modestring (optional) no Ranking mode; omit for the collection's default. vector ranks by similarity; boost adds an exact-token nudge within the vector candidates; hybrid fuses vector and full-text rankings. boost and hybrid require a text query. qstring (optional) no The search text. varray 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_msnumber (optional) no Total server-side time for this request, in ms. matchesarray of SearchResult yes Ranked list of hits, best first. modestring (optional) no Mode that ranked the matches: the requested one, or the collection's default. Scores are cosine similarity for vector and boost, reciprocal-rank fusion scores for hybrid. okboolean no Always true on a success response. query_idstring (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_idstring (optional) no Correlation id echoed for this request. timingSearchTiming (optional)no Per-phase latency breakdown.
SearchResult A single search hit.
Property Type Required Description collectionstring yes Collection the hit came from. idstring yes Chunk id of the matching passage. match_reasonstring yes How the score was made, prefixed by the mode that ranked the hit. vector: the cosine. boost: cosine plus the boost for the exact tokens matched. hybrid: the vector and lexical ranks, each contributing 1/(60+rank). Matched metadata filters and content filters follow after '; '. metaobject yes Provenance and user metadata for the chunk. scorenumber yes Relevance score; higher is closer. tenantstring yes Tenant that owns the hit. textstring (optional) yes The matched snippet, when stored.
SearchTiming Per-phase latency breakdown, in ms.
Property Type Required Description embed_msnumber yes Time to turn the query into a vector. filter_msnumber yes Time spent applying metadata filters. hydrate_msnumber yes Time spent loading snippet text and metadata. lexical_search_msnumber (optional) no FTS5 candidate-generation time for hybrid search. search_msnumber yes Time spent generating ranked candidates. vector_search_msnumber (optional) no Vector candidate-generation time for hybrid search.
UpdateCollectionBody Request body for editing collection metadata.
Property Type Required Description display_namestring yes New human-friendly label.
UpdateCollectionResponse Confirmation of updated collection metadata.
Property Type Required Description display_namestring yes Updated label. latency_msnumber (optional) no Total server-side time for this request, in ms. namestring yes Collection slug. okboolean no Always true on a success response. request_idstring (optional) no Correlation id echoed for this request. tenantstring yes Tenant that owns the collection.
ValidationError Property Type Required Description ctxobject no inputobject no locarray of string, integer (optional) yes msgstring yes typestring yes
Journey complete
You are ready to integrate with PaveDB over HTTP.
Built from PaveDB core 0.9.7
(2026-09-26 ),
Python SDK 0.1.5
(2026-09-26 ),
Elixir Client 0.2.0
(2026-09-26 ),
and TypeScript Client 0.2.0
(2026-09-26 ). Pinned
2026-09-26 .
