Rerank documents

Reranks a list of documents against a query using a reranking model. Returns documents ordered by relevance score. Compatible with the Cohere rerank API format.

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

ID of the rerank model to use.

query*string

The query to rank documents against.

documents*array<string|>

List of documents to rerank. Each item can be a string or an object with a text field.

top_n?integer

Number of top-ranked documents to return. Defaults to all documents.

Range0 < value

return_documents?boolean

Whether to include document text in results. Default: false.

Response Body

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "cohere-rerank-v3-5",    "query": "What is the capital of the United States?",    "documents": [      "Carson City is the capital of Nevada.",      "Washington, D.C. is the capital of the United States."    ]  }'

{
  "object": "list",
  "results": [
    {
      "index": 0,
      "relevance_score": 0,
      "document": {
        "text": "string"
      }
    }
  ],
  "model": "string",
  "usage": {
    "total_tokens": 0
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Rerank documents

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`