diff --git a/.github/workflows/sdk_generation.yaml b/.github/workflows/sdk_generation.yaml new file mode 100644 index 0000000..19dab9a --- /dev/null +++ b/.github/workflows/sdk_generation.yaml @@ -0,0 +1,33 @@ +name: Generate +permissions: + checks: write + contents: write + pull-requests: write + statuses: write + id-token: write +"on": + workflow_dispatch: + inputs: + force: + description: Force generation of SDKs + type: boolean + default: false + set_version: + description: optionally set a specific SDK version + type: string + schedule: + - cron: 0 0 * * * + pull_request: + types: + - labeled + - unlabeled +jobs: + generate: + uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 + with: + force: ${{ github.event.inputs.force }} + mode: pr + set_version: ${{ github.event.inputs.set_version }} + secrets: + github_access_token: ${{ secrets.GITHUB_TOKEN }} + speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} diff --git a/OVERVIEW.md b/OVERVIEW.md new file mode 100644 index 0000000..753e621 --- /dev/null +++ b/OVERVIEW.md @@ -0,0 +1,127 @@ +# OpenRouter Python SDK + +The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API. + +## Why use the OpenRouter SDK? + +Integrating AI models into applications involves handling different provider APIs, managing model-specific requirements, and avoiding common implementation mistakes. The OpenRouter SDK standardizes these integrations and protects you from footguns. + +```python +from openrouter import OpenRouter +import os + +with OpenRouter( + api_key=os.getenv("OPENROUTER_API_KEY") +) as client: + response = client.chat.send( + model="minimax/minimax-m2", + messages=[ + {"role": "user", "content": "Explain quantum computing"} + ] + ) +``` + +The SDK provides three core benefits: + +### Auto-generated from API specifications + +The SDK is automatically generated from OpenRouter's OpenAPI specs and updated with every API change. New models, parameters, and features appear in your IDE autocomplete immediately. No manual updates. No version drift. + +```python +# When new models launch, they're available instantly +response = client.chat.send( + model="minimax/minimax-m2" +) +``` + +### Type-safe by default + +Every parameter, response field, and configuration option is fully typed with Python type hints and validated with Pydantic. Invalid configurations are caught at runtime with clear error messages. + +```python +response = client.chat.send( + model="minimax/minimax-m2", + messages=[ + {"role": "user", "content": "Hello"} + # ← Pydantic validates message structure + ], + temperature=0.7, # ← Type-checked and validated + stream=True # ← Response type changes based on this +) +``` + +**Actionable error messages:** + +```python +# Instead of generic errors, get specific guidance: +# "Model 'openai/o1-preview' requires at least 2 messages. +# You provided 1 message. Add a system or user message." +``` + +**Type-safe streaming:** + +```python +stream = client.chat.send( + model="minimax/minimax-m2", + messages=[{"role": "user", "content": "Write a story"}], + stream=True +) + +for event in stream: + # Full type information for streaming responses + content = event.choices[0].delta.content if event.choices else None +``` + +**Async support:** + +```python +import asyncio + +async def main(): + async with OpenRouter( + api_key=os.getenv("OPENROUTER_API_KEY") + ) as client: + response = await client.chat.send_async( + model="minimax/minimax-m2", + messages=[{"role": "user", "content": "Hello"}] + ) + print(response.choices[0].message.content) + +asyncio.run(main()) +``` + +## Installation + +```bash +# Using uv (recommended) +uv add openrouter + +# Using pip +pip install openrouter + +# Using poetry +poetry add openrouter +``` + +**Requirements:** Python 3.9 or higher + +Get your API key from [openrouter.ai/settings/keys](https://openrouter.ai/settings/keys). + +## Quick start + +```python +from openrouter import OpenRouter +import os + +with OpenRouter( + api_key=os.getenv("OPENROUTER_API_KEY") +) as client: + response = client.chat.send( + model="minimax/minimax-m2", + messages=[ + {"role": "user", "content": "Hello!"} + ] + ) + + print(response.choices[0].message.content) +``` diff --git a/README.md b/README.md index cdef504..f7553a4 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,18 @@ -# openrouter +![hero illustration](./assets/banner.png) -Developer-friendly & type-safe Python SDK specifically catered to leverage *openrouter* API. +# OpenRouter SDK (Beta) -
- - - - Speakeasy Logo - - BUILT BY SPEAKEASY - - - - - LICENSE // MIT - - -
+The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to over 300 models across providers in an easy and type-safe way. +To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python). -

-> [!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** > @@ -72,7 +25,7 @@ The SDK can be installed with *uv*, *pip*, or *poetry* package managers. *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 +uv add openrouter ``` ### PIP @@ -80,7 +33,7 @@ uv add git+.git *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 +pip install openrouter ``` ### Poetry @@ -88,7 +41,7 @@ pip install git+.git *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 +poetry add openrouter ``` ### Shell and script usage with `uv` @@ -123,6 +76,12 @@ 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. + +## Requirements + +This SDK requires Python 3.9 or higher. For Python version support policy, see the SDK Installation section above. + + ## IDE Support @@ -133,10 +92,8 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u - [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/) - -## SDK Example Usage - -### Example + +## SDK Usage ```python # Synchronous Example @@ -148,66 +105,19 @@ with OpenRouter( api_key=os.getenv("OPENROUTER_API_KEY", ""), ) as open_router: - res = open_router.beta.responses.send(input=[ + res = open_router.chat.send(messages=[ { - "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", + ], model="anthropic/claude-4.5-sonnet", provider={ "zdr": True, - "enforce_distillable_text": True, - "order": [ - "OpenAI", - ], - "only": [ - "OpenAI", - ], - "ignore": [ - "OpenAI", - ], - "quantizations": None, "sort": "price", - }) + }, stream=True) - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) + for event in event_stream: + # handle event + print(event, flush=True) ```
@@ -226,874 +136,40 @@ async def main(): 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", - }) + res = await open_router.chat.send_async(messages=[ + { + "role": "user", + "content": "Hello, how are you?", + }, + ], model="anthropic/claude-4.5-sonnet", provider={ + "zdr": True, + "sort": "price", + }, stream=True) - async with res as event_stream: - async for event in event_stream: - # handle event - print(event, flush=True) + 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. - -
- -\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable. - - - -## Server Selection - -### Select Server by Name - -You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: - -| Name | Server | Description | -| ------------ | ------------------------------ | ----------------- | -| `production` | `https://openrouter.ai/api/v1` | Production server | - -#### Example - -```python -from openrouter import OpenRouter -import os - - -with OpenRouter( - server="production", - 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) - -``` - -### Override Server URL Per-Client - -The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: -```python -from openrouter import OpenRouter -import os - - -with OpenRouter( - server_url="https://openrouter.ai/api/v1", - 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) - -``` - - - -## Custom HTTP Client - -The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. -Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. -This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly. - -For example, you could specify a header for every request that this sdk makes as follows: -```python -from openrouter import OpenRouter -import httpx - -http_client = httpx.Client(headers={"x-custom-header": "someValue"}) -s = OpenRouter(client=http_client) -``` - -or you could wrap the client with your own custom logic: -```python -from openrouter import OpenRouter -from openrouter.httpclient import AsyncHttpClient -import httpx - -class CustomClient(AsyncHttpClient): - client: AsyncHttpClient - - def __init__(self, client: AsyncHttpClient): - self.client = client - - async def send( - self, - request: httpx.Request, - *, - stream: bool = False, - auth: Union[ - httpx._types.AuthTypes, httpx._client.UseClientDefault, None - ] = httpx.USE_CLIENT_DEFAULT, - follow_redirects: Union[ - bool, httpx._client.UseClientDefault - ] = httpx.USE_CLIENT_DEFAULT, - ) -> httpx.Response: - request.headers["Client-Level-Header"] = "added by client" - - return await self.client.send( - request, stream=stream, auth=auth, follow_redirects=follow_redirects - ) - - def build_request( - self, - method: str, - url: httpx._types.URLTypes, - *, - content: Optional[httpx._types.RequestContent] = None, - data: Optional[httpx._types.RequestData] = None, - files: Optional[httpx._types.RequestFiles] = None, - json: Optional[Any] = None, - params: Optional[httpx._types.QueryParamTypes] = None, - headers: Optional[httpx._types.HeaderTypes] = None, - cookies: Optional[httpx._types.CookieTypes] = None, - timeout: Union[ - httpx._types.TimeoutTypes, httpx._client.UseClientDefault - ] = httpx.USE_CLIENT_DEFAULT, - extensions: Optional[httpx._types.RequestExtensions] = None, - ) -> httpx.Request: - return self.client.build_request( - method, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - timeout=timeout, - extensions=extensions, - ) - -s = OpenRouter(async_client=CustomClient(httpx.AsyncClient())) -``` - + ## Resource Management @@ -1129,6 +205,10 @@ async def amain(): You can setup your SDK to emit debug logs for SDK requests and responses. You can pass your own logger class directly into your SDK. + +> [!WARNING] +> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. + ```python from openrouter import OpenRouter import logging @@ -1144,108 +224,32 @@ You can also enable a default debug logger by setting an environment variable `O # Development +## Running Tests + +To run the test suite, you'll need to set up your environment with an OpenRouter API key. + +### Local Development + +1. Copy the example environment file: + + ```bash + cp .env.example .env + ``` + +2. Edit `.env` and add your OpenRouter API key: + + ```bash + OPENROUTER_API_KEY=your_api_key_here + ``` + +3. Run the tests: + + ```bash + pytest + ``` + ## Maturity This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally -looking for the latest version. - -## Contributions - -While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. -We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. - -### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openrouter&utm_campaign=python) - - \ No newline at end of file +looking for the latest version. \ No newline at end of file diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 0000000..c970d60 Binary files /dev/null and b/assets/banner.png differ diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..f4e6ea1 --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,10 @@ + + OpenRouter + + + + + + + +