TypeScript SDKAPI ReferenceOperations

CreateRerankRequest - TypeScript SDK

CreateRerankRequest type definition

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

Example Usage

1import { CreateRerankRequest } from "@openrouter/sdk/models/operations";
2
3let value: CreateRerankRequest = {
4  requestBody: {
5    model: "cohere/rerank-v3.5",
6    query: "What is the capital of France?",
7    documents: [
8      "Paris is the capital of France.",
9      "Berlin is the capital of Germany.",
10    ],
11  },
12};

Fields

FieldTypeRequiredDescriptionExample
httpRefererstring➖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.
appTitlestring➖The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
appCategoriesstring➖Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
requestBodyoperations.CreateRerankRequestBody✔️N/A{"model": "cohere/rerank-v3.5","query": "What is the capital of France?","documents": ["Paris is the capital of France.","Berlin is the capital of Germany."],"top_n": 3}