mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-30 12:20:57 +08:00
Matt Apperson
5fc522c72f
Auto-generated Python SDK for OpenRouter API, providing comprehensive client library with: - Chat completions and streaming support - Embeddings API - Model and provider information - API key management - Analytics and usage tracking - OAuth authentication flows - Full type hints and error handling
137 lines
6.7 KiB
Markdown
137 lines
6.7 KiB
Markdown
# Models
|
|
(*models*)
|
|
|
|
## Overview
|
|
|
|
Model information endpoints
|
|
|
|
### Available Operations
|
|
|
|
* [count](#count) - Get total count of available models
|
|
* [list](#list) - List all models and their properties
|
|
* [list_for_user](#list_for_user) - List models filtered by user provider preferences
|
|
|
|
## count
|
|
|
|
Get total count of available models
|
|
|
|
### Example Usage
|
|
|
|
<!-- UsageSnippet language="python" operationID="listModelsCount" method="get" path="/models/count" -->
|
|
```python
|
|
from openrouter import OpenRouter
|
|
import os
|
|
|
|
|
|
with OpenRouter(
|
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
) as open_router:
|
|
|
|
res = open_router.models.count()
|
|
|
|
# Handle response
|
|
print(res)
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
|
|
### Response
|
|
|
|
**[models.ModelsCountResponse](../../models/modelscountresponse.md)**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
| errors.InternalServerResponseError | 500 | application/json |
|
|
| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* |
|
|
|
|
## list
|
|
|
|
List all models and their properties
|
|
|
|
### Example Usage
|
|
|
|
<!-- UsageSnippet language="python" operationID="getModels" method="get" path="/models" -->
|
|
```python
|
|
from openrouter import OpenRouter
|
|
import os
|
|
|
|
|
|
with OpenRouter(
|
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
|
) as open_router:
|
|
|
|
res = open_router.models.list()
|
|
|
|
# Handle response
|
|
print(res)
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
| `category` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
|
|
### Response
|
|
|
|
**[models.ModelsListResponse](../../models/modelslistresponse.md)**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
| errors.BadRequestResponseError | 400 | application/json |
|
|
| errors.InternalServerResponseError | 500 | application/json |
|
|
| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* |
|
|
|
|
## list_for_user
|
|
|
|
List models filtered by user provider preferences
|
|
|
|
### Example Usage
|
|
|
|
<!-- UsageSnippet language="python" operationID="listModelsUser" method="get" path="/models/user" -->
|
|
```python
|
|
from openrouter import OpenRouter, models
|
|
import os
|
|
|
|
|
|
with OpenRouter() as open_router:
|
|
|
|
res = open_router.models.list_for_user(security=models.ListModelsUserSecurity(
|
|
bearer=os.getenv("OPENROUTER_BEARER", ""),
|
|
))
|
|
|
|
# Handle response
|
|
print(res)
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
|
| `security` | [models.ListModelsUserSecurity](../../listmodelsusersecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
|
|
### Response
|
|
|
|
**[models.ModelsListResponse](../../models/modelslistresponse.md)**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
| errors.UnauthorizedResponseError | 401 | application/json |
|
|
| errors.InternalServerResponseError | 500 | application/json |
|
|
| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | |