class

OpenRouter::CompletionRequest

Inherits JSON::Serializable < Reference < Object

Constructors

new(messages : Array(Message), model : String | Nil = nil, tools : Array(Tool) = [] of Tool)

new(pull : JSON::PullParser)

new(prompt : String, model : String | Nil = nil, tools : Array(Tool) = [] of Tool)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

add_tool(tool : Tool)

force_tool_support

force_tool_support=(force_tool_support : Bool)

frequency_penalty

Range: (-2, 2)

frequency_penalty=(frequency_penalty : Float32 | Nil)

Range: (-2, 2)

image_config

Image generation configuration (aspect ratio, size)

image_config=(image_config : ImageConfig | Nil)

Image generation configuration (aspect ratio, size)

logit_bias_key

logit_bias_key=(logit_bias_key : Float32 | Nil)

logit_bias_value

logit_bias_value=(logit_bias_value : Float32 | Nil)

max_tokens

See LLM Parameters (openrouter.ai/docs/parameters)

max_tokens=(max_tokens : Int32 | Nil)

See LLM Parameters (openrouter.ai/docs/parameters)

messages

The chat message history

messages=(messages : Array(Message) | Nil)

The chat message history

min_p

Range: [0, 1]

min_p=(min_p : Float32 | Nil)

Range: [0, 1]

modalities

Output modalities, e.g. ["text"], ["image"], or ["image", "text"] Required for image generation models

modalities=(modalities : Array(String) | Nil)

Output modalities, e.g. ["text"], ["image"], or ["image", "text"] Required for image generation models

model

The model to use.

Browse models at openrouter.ai/models, or use the get_models method of the OpenRouter::Client

model=(model : String | Nil)

The model to use.

Browse models at openrouter.ai/models, or use the get_models method of the OpenRouter::Client

models

for models and route, See "Model Routing" section at openrouter.ai/docs/model-routing

models=(models : Array(String) | Nil)

for models and route, See "Model Routing" section at openrouter.ai/docs/model-routing

presence_penalty

Range: (-2, 2)

presence_penalty=(presence_penalty : Float32 | Nil)

Range: (-2, 2)

prompt

A simple text prompt

prompt=(prompt : String | Nil)

A simple text prompt

provider

See "Provider Routing" section: openrouter.ai/docs/provider-routing

provider=(provider : String | Nil)

See "Provider Routing" section: openrouter.ai/docs/provider-routing

reasoning

Reasoning configuration for models that support reasoning tokens

reasoning=(reasoning : Reasoning | Nil)

Reasoning configuration for models that support reasoning tokens

repetition_penalty

Range: (0, 29)

repetition_penalty=(repetition_penalty : Float32 | Nil)

Range: (0, 29)

respond_with_json

respond_with_json=(respond_with_json : Bool)

route

route=(route : String | Nil)

seed

Advanced optional parameters

seed=(seed : Int32 | Nil)

Advanced optional parameters

stop

the stop tokens

stop=(stop : String | Array(String) | Nil)

the stop tokens

stream

whether to stream the response

stream=(stream : Bool)

whether to stream the response

temperature

temperature=(temperature : Float32 | Nil)

to_json(json : JSON::Builder)

Custom serialization for complex logic

tools

Tool calling Will be passed down as-is for providers implementing OpenAI's interface. For providers with custom interfaces, we transform and map the properties. Otherwise, we transform the tools into a YAML template. The model responds with an assistant message. See models supporting tool calling: openrouter.ai/models?supported_parameters=tools

tools=(tools : Array(Tool))

Tool calling Will be passed down as-is for providers implementing OpenAI's interface. For providers with custom interfaces, we transform and map the properties. Otherwise, we transform the tools into a YAML template. The model responds with an assistant message. See models supporting tool calling: openrouter.ai/models?supported_parameters=tools

top_a

Range: [0, 1]

top_a=(top_a : Float32 | Nil)

Range: [0, 1]

top_k

Range: (1, Infinity) Not available for OpenAI models

top_k=(top_k : Float32 | Nil)

Range: (1, Infinity) Not available for OpenAI models

top_logprobs

top_logprobs=(top_logprobs : Int32 | Nil)

top_p

Range: (0, 1)

top_p=(top_p : Float32 | Nil)

Range: (0, 1)

transforms

Reduce latency by providing the model with a predicted output https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs prediction?: { type: 'content'; content: string; };

OpenRouter-only parameters

provider?: ProviderPreferences; // See "Prompt Transforms" section at openrouter.ai/docs/transforms

transforms=(transforms : Array(String) | Nil)

Reduce latency by providing the model with a predicted output https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs prediction?: { type: 'content'; content: string; };

OpenRouter-only parameters

provider?: ProviderPreferences; // See "Prompt Transforms" section at openrouter.ai/docs/transforms