hosting

GET `/v1/vector/indexes/{indexId}`

One vector index.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה vector.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X GET https://api.zinndigital.com/v1/vector/indexes/{indexId} \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

One index belonging to this organisation. Requires `vector.view`.

פרמטרים

שם	סוג	נדרש	מה זה
`indexId (path)`	`string`	כן	The index's id.

תשובה

שם	סוג	נדרש	מה זה
`id`	`string`	כן	—
`name`	`string`	כן	Lower-case, hyphenated, unique within the organisation.
`dimension`	`integer`	כן	The width your embedding model emits, and the width reads return. Fixed at creation.
`metric`	`string<cosine, l2, inner_product>`	כן	The distance function. Fixed at creation.
`status`	`string<ready, deleting>`	כן	—
`vectors`	`integer`	כן	How many vectors the index holds.
`storage_bytes`	`integer`	כן	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`	כן	—

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 429

GET /v1/vector/indexes/{indexId}