CreateRerankRequest - TypeScript SDK

CreateRerankRequest type definition

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

Example Usage

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

Fields

Field	Type	Required	Description	Example
`httpReferer`	string	➖	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.
`appTitle`	string	➖	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`appCategories`	string	➖	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`requestBody`	operations.CreateRerankRequestBody	✔️	N/A	`{"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?","top_n": 3}`

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