Skip to main content
POST
text.rerank

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

The query to rank the documents against.

documents
string[]
required

The texts to rank, 1 to 200; each at most 32,000 characters, 1,000,000 characters in total.

Required array length: 1 - 200 elements
Required string length: 1 - 32000
topN
number

How many results to return, from 1; at most the number of documents. Default: all of them, ranked.

Required range: 1 <= x <= 200

Response

The result

results
object[]
required

The documents ranked by relevance, best first. Fewer than sent when topN was set.

usage
object
required

Token usage for the call.