Database endpoints
Read a vector index
Returns the configuration of a vector index, addressed by its id or name.
GET /v1/tenants/{tenant}/vector-indexes/{index}
- Address the vector indexUse its ID or name.
- Read shape and stateCheck dimensions, distance metric and availability state.
- Prepare compatible recordsMatch subsequent vectors to the index configuration.
Before you start
Use your database bearer token.
Use the target vector index and, where required, its namespace. The examples use index demo-search and namespace demo.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
index | string | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
Use dimension and metric when preparing vectors, and inspect state before sending work. The response is index metadata; use fetch or search endpoints for records.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 501 | Check deployment support for this operation. |
| 503 | Honor Retry-After when present; check write outcomes. |