---
title: "Rerank different kind of documents for a given query"
method: POST
path: "/v1/reranking"
---

# Rerank different kind of documents for a given query

`POST /v1/reranking`

Rerank different kind of documents for a given query.

Args:
    params: RerankParams: The parameters for reranking.

Returns:
    RerankResponse: The reranked documents for the input query.

## Request body

- RerankParams — Parameters for reranking documents.
  - `model` string — The model to use for reranking documents.
  - `query` string, required — The query to rerank the documents.
  - `input` union[], required — The input documents to rerank.
    - union
      - string
      - unknown
      - unknown[]
        - unknown
  - `rank_fields` string[], nullable — The fields of the documents to rank.
  - `top_k` integer — The number of documents to return.
  - `return_input` boolean — Whether to return the documents.
  - `rewrite_query` boolean — Wether or not to rewrite the query before passing it to the reranking model

## Response `200`

The reranked documents for the input query

- RerankResponse
  - `usage` Usage, required
    - `prompt_tokens` integer, required — The number of tokens used for the prompt
    - `total_tokens` integer, required — The total number of tokens used
    - `completion_tokens` integer, nullable — The number of tokens used for the completion
  - `model` string, required — The model used
  - `data` RankedDocument[], required — The ranked documents.
    - `index` integer, required — The index of the document.
    - `score` number, required — The score of the document.
    - `input` unknown
    - `object` 'rank_result' — The object type.
  - `object` 'list' — The object type of the response
  - `top_k` integer, required — The number of documents to return.
  - `return_input` boolean, required — Whether to return the documents.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/mixedbread/apis/mxbai-omni.md) · [All operations](https://skmtc.net/mixedbread/apis/mxbai-omni/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixedbread/mxbai-omni/versions/2eece97b5ae5/schema)