PaveDB TypeScript Client — API reference (v0.1.1)
Construct with new PaveDBClient({ baseUrl, apiKey });
fetchImpl and timeoutMs are optional. Errors throw PaveDBError
with status, code, and the server message.
| Method | HTTP route |
|---|---|
health() | GET /health |
metrics() | GET /metrics |
version() | GET /health |
listTenants() | GET /v1/admin/tenants |
listEmbedders() | GET /v1/admin/embedders |
getArchive() | GET /v1/admin/archive |
listCollections(tenantName: string) | GET /v1/collections/{tenantName} |
createCollection(tenantName: string, name: string, options?: { display_name?: string; embed_model?: string; embedder_type?: string; embedder_config?: Record<string, unknown>; },) | POST /v1/collections/{tenantName}/{name} |
deleteCollection(tenantName: string, name: string) | DELETE /v1/collections/{tenantName}/{name} |
addDocument(tenantName: string, collection: string, body: { content: string; metadata?: Record<string, unknown> },) | POST /v1/collections/{tenantName}/{collection}/documents |
listDocuments(tenantName: string, collection: string, limit = 20,) | GET /v1/collections/{tenantName}/{collection}/documents?limit={limit} |
metricsSnapshot() | GET /health/metrics |
search(tenantName: string, collection: string, body: Record<string, unknown>,) | POST /v1/collections/{tenantName}/{collection}/search |
Notes
metrics— Prometheus exposition text — NOT JSON.metricsSnapshot— Admin-key counters + hardware snapshot (/health/metrics).