For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
ModelsChatRankingsDocs
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
DocsAPI ReferenceClient SDKsAgent SDKCookbookChangelog
    • Overview
    • Usage for Agents
  • TypeScript SDK
    • Overview
  • Python SDK
    • Overview
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
      • OAuth
      • Observability
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Overview
  • Available Operations
  • rerank
  • Example Usage
  • Parameters
  • Response
  • Errors
Python SDKAPI Reference

Rerank - Python SDK

Rerank method reference
Was this page helpful?
Previous

Beta.Responses - Python SDK

Beta.Responses method reference
Next
Built with

The Python SDK and docs are currently in beta. Report issues on GitHub.

Overview

Rerank endpoints

Available Operations

  • rerank - Submit a rerank request

rerank

Submits a rerank request to the rerank router

Example Usage

1from openrouter import OpenRouter
2import os
3
4with OpenRouter(
5 http_referer="<value>",
6 x_open_router_title="<value>",
7 x_open_router_categories="<value>",
8 api_key=os.getenv("OPENROUTER_API_KEY", ""),
9) as open_router:
10
11 res = open_router.rerank.rerank(documents=[
12 "Paris is the capital of France.",
13 "Berlin is the capital of Germany.",
14 ], model="cohere/rerank-v3.5", query="What is the capital of France?")
15
16 # Handle response
17 print(res)

Parameters

ParameterTypeRequiredDescriptionExample
documentsList[str]✔️The list of documents to rerank[
“Paris is the capital of France.”,
“Berlin is the capital of Germany.”
]
modelstr✔️The rerank model to usecohere/rerank-v3.5
querystr✔️The search query to rerank documents againstWhat is the capital of France?
http_refererOptional[str]➖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]➖The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
x_open_router_categoriesOptional[str]➖Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
providerOptionalNullable[components.ProviderPreferences]➖N/A{"allow_fallbacks": true}
top_nOptional[int]➖Number of most relevant documents to return3
retriesOptional[utils.RetryConfig]➖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*/*