Example Usage
import { MessagesRequest } from "@openrouter/sdk/models";
let value: MessagesRequest = {
messages: [
{
content: "Hello, how are you?",
role: "user",
},
],
model: "anthropic/claude-4.5-sonnet-20250929",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
cacheControl | models.AnthropicCacheControlDirective | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider’s native format. | { “type”: “ephemeral” } |
contextManagement | models.ContextManagement | :heavy_minus_sign: | N/A | |
fallbacks | models.MessagesFallbackParam[] | :heavy_minus_sign: | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with models. Each entry accepts only model. Maximum of 3 entries. | [ { “model”: “claude-opus-4-8” } ] |
maxTokens | number | :heavy_minus_sign: | N/A | |
messages | models.MessagesMessageParam[] | :heavy_check_mark: | N/A | |
metadata | models.MessagesRequestMetadata | :heavy_minus_sign: | N/A | |
model | string | :heavy_check_mark: | N/A | |
models | string[] | :heavy_minus_sign: | N/A | |
outputConfig | models.MessagesOutputConfig | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | { “effort”: “medium” } |
plugins | models.MessagesRequestPlugin[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
provider | models.ProviderPreferences | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | { “allow_fallbacks”: true } |
serviceTier | 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). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | |
speed | models.Speed | :heavy_minus_sign: | N/A | fast |
stopSequences | string[] | :heavy_minus_sign: | N/A | |
stopServerToolsWhen | models.StopServerToolsWhenCondition[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides max_tool_calls. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [ { “step_count”: 5, “type”: “step_count_is” }, { “max_cost_in_dollars”: 0.5, “type”: “max_cost” } ] |
stream | boolean | :heavy_minus_sign: | N/A | |
system | models.System | :heavy_minus_sign: | N/A | |
temperature | number | :heavy_minus_sign: | N/A | |
thinking | models.Thinking | :heavy_minus_sign: | N/A | |
toolChoice | models.ToolChoice | :heavy_minus_sign: | N/A | |
tools | models.MessagesRequestToolUnion[] | :heavy_minus_sign: | N/A | |
topK | number | :heavy_minus_sign: | N/A | |
topP | number | :heavy_minus_sign: | N/A | |
trace | models.TraceConfig | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | { “trace_id”: “trace-abc123”, “trace_name”: “my-app-trace” } |
user | string | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. |