hosting

GET /v1/vector/indexes/{indexId}

One vector index.

Все эндпоинты hosting

Аутентификация

Отправьте ключ 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.

Ответ

ИмяТипОбязательноЧто это
idstringДа
namestringДаLower-case, hyphenated, unique within the organisation.
dimensionintegerДаThe width your embedding model emits, and the width reads return. Fixed at creation.
metricstring<cosine, l2, inner_product>ДаThe distance function. Fixed at creation.
statusstring<ready, deleting>Да
vectorsintegerДаHow many vectors the index holds.
storage_bytesintegerДа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_atstringДа

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429