hosting

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

One vector index.

認証

ベアラートークンとして API キーを送信します。キーには vector.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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