Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění vector.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/vector/indexes/{indexId} \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
One index belonging to this organisation. Requires `vector.view`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
indexId (path) | string | Ano | The index's id. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
name | string | Ano | Lower-case, hyphenated, unique within the organisation. |
dimension | integer | Ano | The width your embedding model emits, and the width reads return. Fixed at creation. |
metric | string<cosine, l2, inner_product> | Ano | The distance function. Fixed at creation. |
status | string<ready, deleting> | Ano | — |
vectors | integer | Ano | How many vectors the index holds. |
storage_bytes | integer | Ano | 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 | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429