Authentication
Send an API key as a bearer token. The key must carry the vector.view 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 GET https://api.zinndigital.com/v1/vector/indexes/{indexId} \
-H "Authorization: Bearer zdk_live_…"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
One index belonging to this organisation. Requires `vector.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
indexId (path) | string | Yes | The index's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | Lower-case, hyphenated, unique within the organisation. |
dimension | integer | Yes | The width your embedding model emits, and the width reads return. Fixed at creation. |
metric | string<cosine, l2, inner_product> | Yes | The distance function. Fixed at creation. |
status | string<ready, deleting> | Yes | — |
vectors | integer | Yes | How many vectors the index holds. |
storage_bytes | integer | Yes | What the index counts for against `vector_index_gb`. A published formula rather than a physical table size, so it is reproducible: 96 bytes of row overhead, plus the stored widt… |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429