Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

​
Example Usage

import { SendChatCompletionRequestRequest } from "@openrouter/sdk/models/operations";

let value: SendChatCompletionRequestRequest = {
  chatRequest: {
    messages: [
      {
        content: "You are a helpful assistant.",
        role: "system",
      },
      {
        content: "What is the capital of France?",
        role: "user",
      },
    ],
  },
};

​
Fields

FieldTypeRequiredDescriptionExample
httpRefererstring: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.
appTitlestring:heavy_minus_sign:The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
appCategoriesstring:heavy_minus_sign:Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
xOpenRouterExperimentalMetadatamodels.MetadataLevel:heavy_minus_sign:Opt-in to surface routing metadata on the response under openrouter_metadata. Defaults to disabled.enabled
chatRequestmodels.ChatRequest:heavy_check_mark:N/A{"max_tokens": 150,"messages": [{"content": "You are a helpful assistant.","role": "system"},
{"content": "What is the capital of France?","role": "user"}
],
“model”: “openai/gpt-4”,
“temperature”: 0.7
}