ChatGenerationParams | OpenRouter TypeScript SDK

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

Example Usage

import { ChatGenerationParams } from "@openrouter/sdk/models";

let value: ChatGenerationParams = {
  messages: [
    {
      role: "system",
      content: "<value>",
    },
  ],
};

Fields

Field	Type	Required	Description
`provider`	models.ChatGenerationParamsProvider	:heavy_minus_sign:	When multiple model providers are available, optionally indicate your routing preference.
`plugins`	models.ChatGenerationParamsPluginUnion[]	:heavy_minus_sign:	Plugins you want to enable for this request, including their settings.
`route`	models.Route	:heavy_minus_sign:	N/A
`user`	string	:heavy_minus_sign:	N/A
`sessionId`	string	:heavy_minus_sign:	A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters.
`messages`	models.Message[]	:heavy_check_mark:	N/A
`model`	string	:heavy_minus_sign:	N/A
`models`	string[]	:heavy_minus_sign:	N/A
`frequencyPenalty`	number	:heavy_minus_sign:	N/A
`logitBias`	`Record<string, number>`	:heavy_minus_sign:	N/A
`logprobs`	boolean	:heavy_minus_sign:	N/A
`topLogprobs`	number	:heavy_minus_sign:	N/A
`maxCompletionTokens`	number	:heavy_minus_sign:	N/A
`maxTokens`	number	:heavy_minus_sign:	N/A
`metadata`	`Record<string, string>`	:heavy_minus_sign:	N/A
`presencePenalty`	number	:heavy_minus_sign:	N/A
`reasoning`	models.Reasoning	:heavy_minus_sign:	N/A
`responseFormat`	models.ChatGenerationParamsResponseFormatUnion	:heavy_minus_sign:	N/A
`seed`	number	:heavy_minus_sign:	N/A
`stop`	models.ChatGenerationParamsStop	:heavy_minus_sign:	N/A
`stream`	boolean	:heavy_minus_sign:	N/A
`streamOptions`	models.ChatStreamOptions	:heavy_minus_sign:	N/A
`temperature`	number	:heavy_minus_sign:	N/A
`toolChoice`	any	:heavy_minus_sign:	N/A
`tools`	models.ToolDefinitionJson[]	:heavy_minus_sign:	N/A
`topP`	number	:heavy_minus_sign:	N/A
`debug`	models.Debug	:heavy_minus_sign:	N/A
`imageConfig`	`Record<string, models.ChatGenerationParamsImageConfig>`	:heavy_minus_sign:	N/A
`modalities`	models.Modality[]	:heavy_minus_sign:	N/A

​Example Usage

​Fields

Example Usage

Fields