Skip to main content
POST
text.embed-options

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
input
string[]
required

The texts to embed, 1 to 96; each at most 32,000 characters, 1,000,000 characters in total. The vectors come back in this order.

Required array length: 1 - 96 elements
Required string length: 1 - 32000
model
enum<string>

Fixed embedding model or stable profile alias. Omission uses the project pin or the 1,024 default.

Available options:
fast,
best,
embed-5,
embed-6,
embed-7,
embed-8,
embed-9,
embed-10,
embed-11,
embed-12,
embed-15,
embed-16,
embed-17,
embed-18,
embed-19,
embed-20
inputType
enum<string>
default:document

Retrieval role.

Available options:
query,
document
dimensions
integer

Requested vector dimensions.

Required range: 2 <= x <= 3072
space
string

Earlier space, with matching explicit profile options. Old aliases are ignored; a fixed name or size must match the space.

Pattern: ^sp_[0-9a-f]{12}$
domain
enum<string>
default:general

Subject area used to select an embedding profile.

Available options:
general,
code,
finance,
legal
purpose
enum<string>
default:retrieval

How the vectors will be used.

Available options:
retrieval,
similarity,
classification,
clustering,
separation
codeTask
enum<string>

Direction for a code profile. Omit for general text.

Available options:
text-to-code,
code-to-code,
code-to-text,
completion,
technical-query,
technical-passage
language
enum<string>
default:multilingual

Language profile; unsupported profiles are refused.

Available options:
multilingual,
english,
german,
chinese
normalized
boolean
default:true

Whether vectors should have unit length.

truncation
boolean
default:false

Allow input beyond the model limit to be shortened. Default false.

encoding
enum<string>
default:float

Number representation. Binary forms pack eight dimensions into each signed or unsigned byte.

Available options:
float,
int8,
uint8,
binary,
ubinary

Response

The result

model
enum<string>
required

Fixed identity of the embedding model that answered.

Available options:
embed-5,
embed-6,
embed-7,
embed-8,
embed-9,
embed-10,
embed-11,
embed-12,
embed-15,
embed-16,
embed-17,
embed-18,
embed-19,
embed-20
space
string
required

Opaque identity of this exact domain, task, encoding and normalization profile.

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

Logical dimensions, before binary packing.

Required range: 2 <= x <= 3072
encoding
enum<string>
required

Representation of each returned vector.

Available options:
float,
int8,
uint8,
binary,
ubinary
embeddings
number[][]
required

One vector per input text, in order. Packed binary vectors contain dimensions divided by eight bytes.

usage
object
required

Input usage.