Chat - Python SDK

Chat method reference

(chat)

Overview

Available Operations

  • send - Create a chat completion

send

Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.

Example Usage

1from openrouter import OpenRouter
2import os
3
4with OpenRouter(
5 api_key=os.getenv("OPENROUTER_API_KEY", ""),
6) as open_router:
7
8 res = open_router.chat.send(messages=[], stream=False)
9
10 with res as event_stream:
11 for event in event_stream:
12 # handle event
13 print(event, flush=True)

Parameters

ParameterTypeRequiredDescription
messagesList[components.Message]✔️N/A
modelOptional[str]N/A
modelsList[str]N/A
frequency_penaltyOptionalNullable[float]N/A
logit_biasDict[str, float]N/A
logprobsOptionalNullable[bool]N/A
top_logprobsOptionalNullable[float]N/A
max_completion_tokensOptionalNullable[float]N/A
max_tokensOptionalNullable[float]N/A
metadataDict[str, str]N/A
presence_penaltyOptionalNullable[float]N/A
reasoningOptional[components.Reasoning]N/A
response_formatOptional[components.ChatGenerationParamsResponseFormatUnion]N/A
seedOptionalNullable[int]N/A
stopOptionalNullable[components.ChatGenerationParamsStop]N/A
streamOptional[bool]N/A
stream_optionsOptionalNullable[components.ChatStreamOptions]N/A
temperatureOptionalNullable[float]N/A
tool_choiceOptional[Any]N/A
toolsList[components.ToolDefinitionJSON]N/A
top_pOptionalNullable[float]N/A
userOptional[str]N/A
retriesOptional[utils.RetryConfig]Configuration to override the default retry behavior of the client.

Response

operations.SendChatCompletionRequestResponse

Errors

Error TypeStatus CodeContent Type
errors.ChatError400, 401, 429application/json
errors.ChatError500application/json
errors.OpenRouterDefaultError4XX, 5XX*/*