Chat | OpenRouter Python SDK | OpenRouter

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

(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

1 from openrouter import OpenRouter
2 import os
3 
4 with 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

Parameter	Type	Required	Description
`messages`	List[components.Message]	✔️	N/A
`provider`	OptionalNullable[components.ChatGenerationParamsProvider]	➖	When multiple model providers are available, optionally indicate your routing preference.
`plugins`	List[components.ChatGenerationParamsPluginUnion]	➖	Plugins you want to enable for this request, including their settings.
`route`	OptionalNullable[components.Route]	➖	N/A
`user`	Optional[str]	➖	N/A
`session_id`	Optional[str]	➖	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.
`model`	Optional[str]	➖	N/A
`models`	List[str]	➖	N/A
`frequency_penalty`	OptionalNullable[float]	➖	N/A
`logit_bias`	Dict[str, float]	➖	N/A
`logprobs`	OptionalNullable[bool]	➖	N/A
`top_logprobs`	OptionalNullable[float]	➖	N/A
`max_completion_tokens`	OptionalNullable[float]	➖	N/A
`max_tokens`	OptionalNullable[float]	➖	N/A
`metadata`	Dict[str, str]	➖	N/A
`presence_penalty`	OptionalNullable[float]	➖	N/A
`reasoning`	Optional[components.Reasoning]	➖	N/A
`response_format`	Optional[components.ResponseFormat]	➖	N/A
`seed`	OptionalNullable[int]	➖	N/A
`stop`	OptionalNullable[components.Stop]	➖	N/A
`stream`	Optional[bool]	➖	N/A
`stream_options`	OptionalNullable[components.ChatStreamOptions]	➖	N/A
`temperature`	OptionalNullable[float]	➖	N/A
`tool_choice`	Optional[Any]	➖	N/A
`tools`	List[components.ToolDefinitionJSON]	➖	N/A
`top_p`	OptionalNullable[float]	➖	N/A
`debug`	Optional[components.Debug]	➖	N/A
`image_config`	Dict[str, components.ChatGenerationParamsImageConfig]	➖	N/A
`modalities`	List[components.Modality]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.SendChatCompletionRequestResponse

Errors

Error Type	Status Code	Content Type
errors.ChatError	400, 401, 429	application/json
errors.ChatError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

1	from openrouter import OpenRouter
2	import os
3
4	with 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)