Vectors API

Vector database for embeddings

REST API endpoints for Vectors. 5 operations.

Batch upsert vectors

plaintext

POST /api/v1/tenants/{tenant_id}/vectors/batch/upsert

Inserts or updates many vectors in a collection in a single request (one multi-row write). Returns the number of vectors upserted.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Request body

application/json (required) — schema VectorUpsertRequest.

Responses

Status	Description
`201`	Vectors upserted (count returned)
`400`	Invalid request (e.g. dimension mismatch or batch too large)
`401`	Missing or invalid API key
`503`	Vector store unavailable

operationId: batchUpsertVectors

List vector collections

plaintext

GET /api/v1/tenants/{tenant_id}/vectors/collections

Returns the vector collections for a tenant.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Responses

Status	Description
`200`	Collection list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listVectorCollections

Create a vector collection

plaintext

POST /api/v1/tenants/{tenant_id}/vectors/collections

Creates a new vector collection for a tenant.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Responses

Status	Description
`201`	Collection created
`401`	Missing or invalid API key
`500`	Internal error

operationId: createVectorCollection

Search vectors

plaintext

POST /api/v1/tenants/{tenant_id}/vectors/search

Runs a nearest-neighbour vector search and returns scored matches.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Request body

application/json (required) — schema VectorSearchRequest.

Responses

Status	Description
`200`	Search results with scores
`401`	Missing or invalid API key
`500`	Internal error

operationId: searchVectors

Upsert vectors

plaintext

POST /api/v1/tenants/{tenant_id}/vectors/upsert

Inserts or updates a batch of vectors in a collection.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Request body

application/json (required) — schema VectorUpsertRequest.

Responses

Status	Description
`200`	Vectors upserted
`401`	Missing or invalid API key
`500`	Internal error

operationId: upsertVectors