ChatGenerationParams - TypeScript SDK

ChatGenerationParams method reference

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

Example Usage

1import { ChatGenerationParams } from "@openrouter/sdk/models";
2
3let value: ChatGenerationParams = {
4 messages: [
5 {
6 role: "system",
7 content: "<value>",
8 },
9 ],
10};

Fields

FieldTypeRequiredDescription
providermodels.ChatGenerationParamsProviderWhen multiple model providers are available, optionally indicate your routing preference.
pluginsmodels.ChatGenerationParamsPluginUnion[]Plugins you want to enable for this request, including their settings.
routemodels.ChatGenerationParamsRouteRouting strategy for multiple models: “fallback” (default) uses secondary models as backups, “sort” sorts all endpoints together by routing criteria.
userstringN/A
sessionIdstringA 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.
messagesmodels.Message[]✔️N/A
modelstringN/A
modelsstring[]N/A
frequencyPenaltynumberN/A
logitBiasRecord<string, *number*>N/A
logprobsbooleanN/A
topLogprobsnumberN/A
maxCompletionTokensnumberN/A
maxTokensnumberN/A
metadataRecord<string, *string*>N/A
presencePenaltynumberN/A
reasoningmodels.ReasoningN/A
responseFormatmodels.ChatGenerationParamsResponseFormatUnionN/A
seednumberN/A
stopmodels.ChatGenerationParamsStopN/A
streambooleanN/A
streamOptionsmodels.ChatStreamOptionsN/A
temperaturenumberN/A
toolChoiceanyN/A
toolsmodels.ToolDefinitionJson[]N/A
topPnumberN/A
debugmodels.DebugN/A