---
title: "Rerank documents"
method: POST
path: "/rerank"
---

# Rerank documents

`POST /rerank`

## Request

- Base URL: `https://www.ninjachat.ai/api/v1`
- URL: `https://www.ninjachat.ai/api/v1/rerank`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string

## Request body

- RerankRequest
  - `model` 'rerank-2.5' | 'rerank-2.5-lite', required
  - `query` string, required
  - `documents` string[], required
  - `top_n` integer
  - `return_documents` boolean
  - `truncation` boolean

## Response `200`

Document relevance and metered usage.

- RerankResponse
  - `model` string, required
  - `provider` string, required
  - `results` object[], required
    - `index` integer, required
    - `relevance_score` number, required
    - `document` object
      - `text` string, required
  - `usage` object, required
    - `total_tokens` integer, required
  - `cost_usd` number, required
  - `request_id` string, required

## Other responses

- `400`: Invalid or unsupported request parameter.
- `401`: Missing or invalid API key.
- `402`: Insufficient balance or project spend limit reached.
- `429`: Rate limit exceeded.
- `500`: Gateway error.

---

[API](https://skmtc.dev/ninjachat/apis/ninjachat-api.md) · [All operations](https://skmtc.dev/ninjachat/apis/ninjachat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ninjachat/apis/ninjachat-api/revisions/fa7dfcbdcb03?raw)
