Skip to main content

Overview

Rerank endpoints

Available Operations

  • rerank - Submit a rerank request

rerank

Submits a rerank request to the rerank router

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.rerank.rerank(documents=[
        "Paris is the capital of France.",
        "Berlin is the capital of Germany.",
    ], model="cohere/rerank-v3.5", query="What is the capital of France?")

    # Handle response
    print(res)

Parameters

ParameterTypeRequiredDescriptionExample
documentsList[operations.Document]:heavy_check_mark:The list of documents to rerank. Documents may be plain strings, or structured objects with text and/or image for multimodal models.[
“Paris is the capital of France.”,
“Berlin is the capital of Germany.”
]
modelstr:heavy_check_mark:The rerank model to usecohere/rerank-v3.5
querystr:heavy_check_mark:The search query to rerank documents againstWhat is the capital of France?
http_refererOptional[str]:heavy_minus_sign:The app identifier should be your app’s URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
x_open_router_titleOptional[str]:heavy_minus_sign:The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
x_open_router_categoriesOptional[str]:heavy_minus_sign:Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
providerOptionalNullable[components.ProviderPreferences]:heavy_minus_sign:N/A{
“allow_fallbacks”: true
}
top_nOptional[int]:heavy_minus_sign:Number of most relevant documents to return3
retriesOptional[utils.RetryConfig]:heavy_minus_sign:Configuration to override the default retry behavior of the client.

Response

operations.CreateRerankResponse

Errors

Error TypeStatus CodeContent Type
errors.BadRequestResponseError400application/json
errors.UnauthorizedResponseError401application/json
errors.PaymentRequiredResponseError402application/json
errors.NotFoundResponseError404application/json
errors.TooManyRequestsResponseError429application/json
errors.InternalServerResponseError500application/json
errors.BadGatewayResponseError502application/json
errors.ServiceUnavailableResponseError503application/json
errors.EdgeNetworkTimeoutResponseError524application/json
errors.ProviderOverloadedResponseError529application/json
errors.OpenRouterDefaultError4XX, 5XX*/*