Skip to main content
POST
vector.index.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string

The ref returned by vector.index.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
index
string

Your own index name, as given to vector.index.create. Send this or ref.

Pattern: ^[a-z][a-z0-9-]{1,23}$

Response

The result

index
string
required

The index's name, as given at creation.

Pattern: ^[a-z][a-z0-9-]{1,23}$
dimension
number
required

The vector length every stored vector has.

metric
enum<string>
required

How similarity is scored: "cosine" (angle, default), "dot" (raw dot product) or "euclidean" (straight-line distance). Fixed at creation.

Available options:
cosine,
dot,
euclidean
space
string

The vector space the index is tied to, when one was set at creation; queries naming a different space are refused.

Pattern: ^sp_[0-9a-f]{12}$
vectorCount
number

Approximate number of vectors stored. Absent when the store cannot count right now.