# Create rerank - Documentation

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown is available with `Accept: text/markdown` and `.md` URL variants.

Source: /docs/api-reference/model-apis-llm-create-rerank

# Create rerank

POST

/

openai

/

v1

/

rerank

Try it

Create rerank

cURL

```
curl --request POST \
--url https://api.novita.ai/openai/v1/rerank \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"model": "<string>",
"query": "<string>",
"documents": [
"<string>"
],
"top_n": 123
}
'
```

200

```
{
"id": "<string>",
"results": [
{
"document": {
"text": "<string>"
},
"index": 123,
"relevance_score": 123
}
],
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123
}
}
```

Creates a rerank request.

##

[​](#request-headers)

Request Headers

[​](#param-content-type)

Content-Type

string

required

Enum: `application/json`

[​](#param-authorization)

Authorization

string

required

Bearer authentication format, for example: Bearer {{API Key}}.

##

[​](#request-body)

Request Body

[​](#param-model)

model

string

required

The name of the model to use.

[​](#param-query)

query

string

required

The search query.

[​](#param-documents)

documents

string[]

required

Document List.

[​](#param-top-n)

top_n

integer

Number of most relevant documents or indices to return.

##

[​](#response)

Response

[​](#param-id)

id

string

required

ID

[​](#param-results)

results

object[]

required

Show properties

[​](#param-document)

document

object

Original document content.

Show properties

[​](#param-text)

text

string

[​](#param-index)

index

integer

The index value of the position in the input candidate doc array.

[​](#param-relevance-score)

relevance_score

number

Similarity score.

[​](#param-usage)

usage

object

Token usage statistics.

Show properties

[​](#param-completion-tokens)

completion_tokens

integer

required

The number of tokens in the generated completion.

[​](#param-prompt-tokens)

prompt_tokens

integer

required

The number of tokens in the prompt.

[​](#param-total-tokens)

total_tokens

integer

required

The total number of tokens used in the request (prompt + completion).

Last modified on August 12, 2025