Overview
Rerank endpointsAvailable Operations
- rerank - Submit a rerank request
rerank
Submits a rerank request to the rerank routerExample 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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
documents | List[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.” ] |
model | str | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 |
query | str | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? |
http_referer | Optional[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_title | Optional[str] | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
x_open_router_categories | Optional[str] | :heavy_minus_sign: | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
provider | OptionalNullable[components.ProviderPreferences] | :heavy_minus_sign: | N/A | { “allow_fallbacks”: true } |
top_n | Optional[int] | :heavy_minus_sign: | Number of most relevant documents to return | 3 |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
operations.CreateRerankResponseErrors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponseError | 400 | application/json |
| errors.UnauthorizedResponseError | 401 | application/json |
| errors.PaymentRequiredResponseError | 402 | application/json |
| errors.NotFoundResponseError | 404 | application/json |
| errors.TooManyRequestsResponseError | 429 | application/json |
| errors.InternalServerResponseError | 500 | application/json |
| errors.BadGatewayResponseError | 502 | application/json |
| errors.ServiceUnavailableResponseError | 503 | application/json |
| errors.EdgeNetworkTimeoutResponseError | 524 | application/json |
| errors.ProviderOverloadedResponseError | 529 | application/json |
| errors.OpenRouterDefaultError | 4XX, 5XX | */* |