Document Reranking

POST

/v1/rerank

Rerank a list of documents by relevance to a query

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Example

{
    "model": "rerank-english-v2.0",
    "query": "string",
    "documents": [
        "string"
    ],
    "top_n": 0,
    "return_documents": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/rerank' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "model": "rerank-english-v2.0",
    "query": "string",
    "documents": [
        "string"
    ],
    "top_n": 0,
    "return_documents": false
}'

Responses

🟢200Success

application/json

Reranking completed successfully

Bodyapplication/json

Example

{
    "id": "string",
    "results": [
        {
            "index": 0,
            "relevance_score": 0,
            "document": {}
        }
    ],
    "meta": {}
}

Modified at 2026-05-23 05:25:15

Native OpenAI Format