Skip to main content
POST
vector.vectors.upsert

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
vectors
object[]
required

The vectors to store, 1 to 1,000 per call. An existing id is replaced. A large call is sent to the store in several parts; if it fails part-way some vectors may be stored, and sending the same call again is safe.

Required array length: 1 - 1000 elements
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

upserted
number
required

How many vectors were written.