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
      • Analytics
      • APIKeys
      • Byok
      • Chat
      • Credits
      • Embeddings
      • Endpoints
      • Generations
      • Guardrails
      • OAuth
      • Observability
        • SendChatCompletionRequestRequest
      • Organization
      • Presets
      • Providers
      • Rerank
      • Beta.Responses
      • Transcriptions
      • Speech
      • VideoGeneration
      • Workspaces
  • Python SDK
    • Overview
  • Go SDK
  • DevTools
    • Overview
    • Migrating to @openrouter/agent
LogoLogo
ModelsChatRankingsDocs
On this page
  • Example Usage
  • Fields
TypeScript SDKAPI ReferenceOperations

SendChatCompletionRequestRequest - TypeScript SDK

SendChatCompletionRequestRequest type definition
Was this page helpful?
Previous

Organization - TypeScript SDK

Organization method reference
Next
Built with

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

Example Usage

1import { SendChatCompletionRequestRequest } from "@openrouter/sdk/models/operations";
2
3let value: SendChatCompletionRequestRequest = {
4 chatRequest: {
5 messages: [
6 {
7 content: "You are a helpful assistant.",
8 role: "system",
9 },
10 {
11 content: "What is the capital of France?",
12 role: "user",
13 },
14 ],
15 },
16};

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.
xOpenRouterExperimentalMetadatamodels.MetadataLevel➖Opt-in to surface routing metadata on the response under openrouter_metadata. Defaults to disabled.enabled
chatRequestmodels.ChatRequest✔️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
}