Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso vector.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/vector/indexes/{indexId} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
One index belonging to this organisation. Requires `vector.view`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
indexId (path) | string | Sí | The index's id. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | — |
name | string | Sí | Lower-case, hyphenated, unique within the organisation. |
dimension | integer | Sí | The width your embedding model emits, and the width reads return. Fixed at creation. |
metric | string<cosine, l2, inner_product> | Sí | The distance function. Fixed at creation. |
status | string<ready, deleting> | Sí | — |
vectors | integer | Sí | How many vectors the index holds. |
storage_bytes | integer | Sí | 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 | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429