Skip to main content
POST
Rerank documents

Authorizations

Authorization
string
header
required

Your workspace API key, e.g. sk_sovereign_..., sent as Authorization: Bearer .

Body

application/json
model
string
required
query
string
required

The query to rank documents against.

documents
string[]
required

The documents to rerank.

top_n
integer

Return only the top N results.

return_documents
boolean

Include the document text in each result.

max_chunks_per_doc
integer

Maximum chunks per document.

Response

Ranked results.

results
object[]
usage
object