Skip to main content
POST
Rerank documents
Use this endpoint to reorder candidate documents before they are passed to a search, retrieval, or generation step. Verify the model in GET /v1/models before deployment. The default response contains only models with a public Gateway route.

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
model
string
required
query
string
required
documents
required
Minimum array length: 1
top_n
integer
Required range: x >= 1
top_k
integer

Alias for top_n.

Required range: x >= 1
return_documents
boolean
max_chunks_per_doc
integer
Required range: x >= 1
rank_fields
string[]
user
string
metadata
object
provider_options
object
debug
object

Gateway debug controls. These flags are never forwarded upstream.

provider
object

Provider routing preferences for gateway selection.

Response

200 - application/json

Rerank response

object
string
id
string
nativeResponseId
string | null
model
string
results
object[]
usage
object
Last modified on August 30, 2026