Skip to main content
POST
vector.index.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
index
string
required

A name you choose for the index, 2-24 characters: a lowercase letter, then lowercase letters, digits or dashes. Used to address the index later (as index) and shown in vector.indexes.list.

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

Vector length for the index, one of: 32, 64, 128, 256, 384, 512, 768, 1024, 1536, 2048, 3072. Every vector upserted later must have exactly this length; text.embed produces these sizes.

metric
enum<string>

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

Tie the index to one text.embed vector space; queries naming a different space are refused. Omit to allow any space.

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

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
status
enum<string>
required

"ready" when the index can take vectors at once. "initializing" means the store is still being prepared and nothing is stored yet: send the same create call again shortly.

Available options:
ready,
initializing
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.

ref
string

Reference to what this call created. Pass it as ref to vector.index.delete, vector.index.get, vector.vectors.upsert, vector.vectors.query, vector.vectors.get, vector.vectors.delete.