# openrouter
Developer-friendly & type-safe Python SDK specifically catered to leverage *openrouter* API.
> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/openrouter/sdk). Delete this section before > publishing to a package manager.
## Summary
OpenRouter API: OpenAI-compatible Chat Completions and Completions API with additional OpenRouter features
For more information about the API: [OpenRouter Documentation](https://openrouter.ai/docs)
## Table of Contents
* [openrouter](#openrouter)
* [SDK Installation](#sdk-installation)
* [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Server-sent event streaming](#server-sent-event-streaming)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Resource Management](#resource-management)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## SDK Installation
> [!TIP]
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
### uv
*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
```bash
uv add git+.git
```
### PIP
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
pip install git+.git
```
### Poetry
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
```bash
poetry add git+.git
```
### Shell and script usage with `uv`
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
```shell
uvx --from openrouter python
```
It's also possible to write a standalone Python script without needing to set up a whole project like so:
```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "openrouter",
# ]
# ///
from openrouter import OpenRouter
sdk = OpenRouter(
# SDK arguments
)
# Rest of script here...
```
Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
## SDK Example Usage
### Example
```python
# Synchronous Example
from openrouter import OpenRouter
import os
with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
```
The same SDK client can also be used to make asynchronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from openrouter import OpenRouter
import os
async def main():
async with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = await open_router.beta.responses.send_async(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
async with res as event_stream:
async for event in event_stream:
# handle event
print(event, flush=True)
asyncio.run(main())
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| --------- | ---- | ----------- | -------------------- |
| `api_key` | http | HTTP Bearer | `OPENROUTER_API_KEY` |
To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
```python
from openrouter import OpenRouter
import os
with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
```
### Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
```python
from openrouter import OpenRouter, models
import os
with OpenRouter() as open_router:
res = open_router.credits.create_coinbase_charge(security=models.CreateCoinbaseChargeSecurity(
bearer=os.getenv("OPENROUTER_BEARER", ""),
), amount=100, sender="0x1234567890123456789012345678901234567890", chain_id=1)
# Handle response
print(res)
```
## Available Resources and Operations
Available methods
### [analytics](docs/sdks/analytics/README.md)
* [get_user_activity](docs/sdks/analytics/README.md#get_user_activity) - Get user activity grouped by endpoint
### [api_keys](docs/sdks/apikeys/README.md)
* [list](docs/sdks/apikeys/README.md#list) - List API keys
* [create](docs/sdks/apikeys/README.md#create) - Create a new API key
* [update](docs/sdks/apikeys/README.md#update) - Update an API key
* [delete](docs/sdks/apikeys/README.md#delete) - Delete an API key
* [get](docs/sdks/apikeys/README.md#get) - Get a single API key
* [get_current_key_metadata](docs/sdks/apikeys/README.md#get_current_key_metadata) - Get current API key
#### [beta.responses](docs/sdks/responses/README.md)
* [send](docs/sdks/responses/README.md#send) - Create a response
### [chat](docs/sdks/chat/README.md)
* [send](docs/sdks/chat/README.md#send) - Create a chat completion
### [completions](docs/sdks/completions/README.md)
* [generate](docs/sdks/completions/README.md#generate) - Create a completion
### [credits](docs/sdks/credits/README.md)
* [get_credits](docs/sdks/credits/README.md#get_credits) - Get remaining credits
* [create_coinbase_charge](docs/sdks/credits/README.md#create_coinbase_charge) - Create a Coinbase charge for crypto payment
### [embeddings](docs/sdks/embeddings/README.md)
* [generate](docs/sdks/embeddings/README.md#generate) - Submit an embedding request
* [list_models](docs/sdks/embeddings/README.md#list_models) - List all embeddings models
### [endpoints](docs/sdks/endpoints/README.md)
* [list](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
* [list_zdr_endpoints](docs/sdks/endpoints/README.md#list_zdr_endpoints) - Preview the impact of ZDR on the available endpoints
### [generations](docs/sdks/generations/README.md)
* [get_generation](docs/sdks/generations/README.md#get_generation) - Get request & usage metadata for a generation
### [models](docs/sdks/models/README.md)
* [count](docs/sdks/models/README.md#count) - Get total count of available models
* [list](docs/sdks/models/README.md#list) - List all models and their properties
* [list_for_user](docs/sdks/models/README.md#list_for_user) - List models filtered by user provider preferences
### [o_auth](docs/sdks/oauth/README.md)
* [exchange_auth_code_for_api_key](docs/sdks/oauth/README.md#exchange_auth_code_for_api_key) - Exchange authorization code for API key
* [create_auth_code](docs/sdks/oauth/README.md#create_auth_code) - Create authorization code
### [parameters](docs/sdks/parameters/README.md)
* [get_parameters](docs/sdks/parameters/README.md#get_parameters) - Get a model's supported parameters and data about which are most popular
### [providers](docs/sdks/providers/README.md)
* [list](docs/sdks/providers/README.md#list) - List all providers
## Server-sent event streaming
[Server-sent events][mdn-sse] are used to stream content from certain
operations. These operations will expose the stream as [Generator][generator] that
can be consumed using a simple `for` loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
The stream is also a [Context Manager][context-manager] and can be used with the `with` statement and will close the
underlying connection when the context is exited.
```python
from openrouter import OpenRouter
import os
with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
```
[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
[generator]: https://book.pythontips.com/en/latest/generators.html
[context-manager]: https://book.pythontips.com/en/latest/context_managers.html
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from openrouter import OpenRouter
from openrouter.utils import BackoffStrategy, RetryConfig
import os
with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from openrouter import OpenRouter
from openrouter.utils import BackoffStrategy, RetryConfig
import os
with OpenRouter(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
```
## Error Handling
[`OpenRouterError`](./src/openrouter/errors/openroutererror.py) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message` | `str` | Error message |
| `err.status_code` | `int` | HTTP response status code eg `404` |
| `err.headers` | `httpx.Headers` | HTTP response headers |
| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |
| `err.raw_response` | `httpx.Response` | Raw HTTP response |
| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
### Example
```python
from openrouter import OpenRouter, errors
import os
with OpenRouter(
api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:
res = None
try:
res = open_router.beta.responses.send(input=[
{
"type": "message",
"role": "user",
"content": "Hello, how are you?",
},
], metadata={
"user_id": "123",
"session_id": "abc-def-ghi",
}, tools=[
{
"type": "function",
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
},
},
},
},
], model="anthropic/claude-4.5-sonnet-20250929", text={
"format_": {
"type": "text",
},
"verbosity": "medium",
}, reasoning={
"summary": "auto",
"enabled": True,
}, temperature=0.7, top_p=0.9, prompt={
"id": "",
"variables": {
"key": {
"type": "input_text",
"text": "Hello, how can I help you?",
},
},
}, service_tier="auto", truncation="auto", stream=False, provider={
"data_collection": "deny",
"zdr": True,
"enforce_distillable_text": True,
"order": [
"OpenAI",
],
"only": [
"OpenAI",
],
"ignore": [
"OpenAI",
],
"quantizations": None,
"sort": "price",
})
with res as event_stream:
for event in event_stream:
# handle event
print(event, flush=True)
except errors.OpenRouterError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, errors.BadRequestResponseError):
print(e.data.error) # models.BadRequestResponseErrorData
print(e.data.user_id) # OptionalNullable[str]
```
### Error Classes
**Primary errors:**
* [`OpenRouterError`](./src/openrouter/errors/openroutererror.py): The base class for HTTP error responses.
* [`InternalServerResponseError`](./src/openrouter/errors/internalserverresponseerror.py): Internal Server Error - Unexpected server error. Status code `500`. *
Less common errors (19)
**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
* [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
* [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
**Inherit from [`OpenRouterError`](./src/openrouter/errors/openroutererror.py)**:
* [`UnauthorizedResponseError`](./src/openrouter/errors/unauthorizedresponseerror.py): Unauthorized - Authentication required or invalid credentials. Status code `401`. Applicable to 15 of 24 methods.*
* [`BadRequestResponseError`](./src/openrouter/errors/badrequestresponseerror.py): Bad Request - Invalid request parameters or malformed input. Status code `400`. Applicable to 10 of 24 methods.*
* [`TooManyRequestsResponseError`](./src/openrouter/errors/toomanyrequestsresponseerror.py): Too Many Requests - Rate limit exceeded. Status code `429`. Applicable to 9 of 24 methods.*
* [`NotFoundResponseError`](./src/openrouter/errors/notfoundresponseerror.py): Not Found - Resource does not exist. Status code `404`. Applicable to 8 of 24 methods.*
* [`PaymentRequiredResponseError`](./src/openrouter/errors/paymentrequiredresponseerror.py): Payment Required - Insufficient credits or quota to complete request. Status code `402`. Applicable to 3 of 24 methods.*
* [`ForbiddenResponseError`](./src/openrouter/errors/forbiddenresponseerror.py): Forbidden - Authentication successful but insufficient permissions. Status code `403`. Applicable to 3 of 24 methods.*
* [`BadGatewayResponseError`](./src/openrouter/errors/badgatewayresponseerror.py): Bad Gateway - Provider/upstream API failure. Status code `502`. Applicable to 3 of 24 methods.*
* [`EdgeNetworkTimeoutResponseError`](./src/openrouter/errors/edgenetworktimeoutresponseerror.py): Infrastructure Timeout - Provider request timed out at edge network. Status code `524`. Applicable to 3 of 24 methods.*
* [`ProviderOverloadedResponseError`](./src/openrouter/errors/provideroverloadedresponseerror.py): Provider Overloaded - Provider is temporarily overloaded. Status code `529`. Applicable to 3 of 24 methods.*
* [`ChatError`](./src/openrouter/errors/chaterror.py): Bad request - invalid parameters. Applicable to 2 of 24 methods.*
* [`ServiceUnavailableResponseError`](./src/openrouter/errors/serviceunavailableresponseerror.py): Service Unavailable - Service temporarily unavailable. Status code `503`. Applicable to 2 of 24 methods.*
* [`RequestTimeoutResponseError`](./src/openrouter/errors/requesttimeoutresponseerror.py): Request Timeout - Operation exceeded time limit. Status code `408`. Applicable to 1 of 24 methods.*
* [`PayloadTooLargeResponseError`](./src/openrouter/errors/payloadtoolargeresponseerror.py): Payload Too Large - Request payload exceeds size limits. Status code `413`. Applicable to 1 of 24 methods.*
* [`UnprocessableEntityResponseError`](./src/openrouter/errors/unprocessableentityresponseerror.py): Unprocessable Entity - Semantic validation failure. Status code `422`. Applicable to 1 of 24 methods.*
* [`ResponseValidationError`](./src/openrouter/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.