hosting

POST /v1/vector/indexes/{indexId}/vectors

Insert or replace vectors.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the vector.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/vector/indexes/{indexId}/vectors \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "vectors": <Vector[]> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Writes vectors by your own id: an id already in the index is replaced, not duplicated. Every vector must carry exactly `dimension` values. Refused when the write would take the organisation past its `vector_index_gb` allowance. Requires `vector.manage`.

Parameters

NameTypeRequiredWhat it is
indexId (path)stringYesThe index's id.

Request body

NameTypeRequiredWhat it is
vectorsVector[]Yes

Response

NameTypeRequiredWhat it is
upsertedintegerYesHow many vectors this call wrote.
vectorsintegerYesThe index's new total.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429