mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-08-01 12:40:23 +08:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Matt AppersonandGitHub
|
b2386114cd | ||
|
|
2bba049182 | ||
|
|
e8953c70bd | ||
|
|
29fdfcedc3 | ||
|
|
c0959955c1 | ||
|
|
a0a7edecfa | ||
|
|
4e84bb736b | ||
|
|
947e92e68d | ||
|
|
bdbd8becc2 | ||
|
|
6ef088e7c7 | ||
|
|
e4e5cc259a | ||
|
Matt AppersonandGitHub
|
06bea2ae0f | ||
|
Matt AppersonandGitHub
|
6b1b7e6a9d | ||
|
Matt AppersonandGitHub
|
dd8e6bdac2 | ||
|
Matt Apperson
|
e6b0242969 | ||
|
OpenRouter SDK Bot
|
5ab44f08f0 | ||
|
robert-j-yandGitHub
|
e72a84e82d | ||
|
OpenRouter Team
|
c734c52d9c | ||
|
Shashank GoyalandGitHub
|
b2098ff28e | ||
|
OpenRouter Team
|
1cad51abb6 |
@@ -1,9 +1,4 @@
|
|||||||
|
|
||||||
<div align="center">
|
|
||||||
<a href="https://codespaces.new/OpenRouterTeam/python-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
|
|
||||||
</div>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
||||||
|
|
||||||
# Dev Containers Quick Start
|
# Dev Containers Quick Start
|
||||||
|
|||||||
+14
-2
@@ -1,13 +1,25 @@
|
|||||||
.venv/
|
|
||||||
venv/
|
venv/
|
||||||
src/*.egg-info/
|
src/*.egg-info/
|
||||||
**/__pycache__/
|
**/__pycache__/
|
||||||
.pytest_cache/
|
.pytest_cache/
|
||||||
.python-version
|
.python-version
|
||||||
.DS_Store
|
|
||||||
pyrightconfig.json
|
pyrightconfig.json
|
||||||
**/.speakeasy/temp/
|
**/.speakeasy/temp/
|
||||||
**/.speakeasy/logs/
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
|
# Build artifacts
|
||||||
|
/dist
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*.egg-info/
|
||||||
|
*.egg
|
||||||
|
# Speakeasy generation artifacts (generated in OSS repo, not here)
|
||||||
|
.speakeasy/*.lock
|
||||||
|
.speakeasy/*.openapi.yaml
|
||||||
|
/docs
|
||||||
|
# Environment
|
||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
.DS_Store
|
||||||
|
.venv/
|
||||||
|
|||||||
+5124
-963
File diff suppressed because it is too large
Load Diff
+5
-1
@@ -25,13 +25,14 @@ generation:
|
|||||||
schemas:
|
schemas:
|
||||||
allOfMergeStrategy: shallowMerge
|
allOfMergeStrategy: shallowMerge
|
||||||
requestBodyFieldName: ""
|
requestBodyFieldName: ""
|
||||||
|
persistentEdits: {}
|
||||||
tests:
|
tests:
|
||||||
generateTests: false
|
generateTests: false
|
||||||
generateNewTests: true
|
generateNewTests: true
|
||||||
skipResponseBodyAssertions: false
|
skipResponseBodyAssertions: false
|
||||||
preApplyUnionDiscriminators: true
|
preApplyUnionDiscriminators: true
|
||||||
python:
|
python:
|
||||||
version: 0.3.1
|
version: 0.9.1
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dev: {}
|
dev: {}
|
||||||
main: {}
|
main: {}
|
||||||
@@ -46,6 +47,7 @@ python:
|
|||||||
- OpenRouter
|
- OpenRouter
|
||||||
baseErrorName: OpenRouterError
|
baseErrorName: OpenRouterError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
constFieldCasing: upper
|
||||||
defaultErrorName: OpenRouterDefaultError
|
defaultErrorName: OpenRouterDefaultError
|
||||||
description: Official Python Client SDK for OpenRouter.
|
description: Official Python Client SDK for OpenRouter.
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
@@ -57,6 +59,7 @@ python:
|
|||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
flattenRequests: true
|
flattenRequests: true
|
||||||
flatteningOrder: parameters-first
|
flatteningOrder: parameters-first
|
||||||
|
forwardCompatibleUnionsByDefault: tagged-only
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
@@ -77,6 +80,7 @@ python:
|
|||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageManager: uv
|
packageManager: uv
|
||||||
packageName: openrouter
|
packageName: openrouter
|
||||||
|
preApplyUnionDiscriminators: false
|
||||||
pytestFilterWarnings: []
|
pytestFilterWarnings: []
|
||||||
pytestTimeout: 0
|
pytestTimeout: 0
|
||||||
responseFormat: flat
|
responseFormat: flat
|
||||||
|
|||||||
+18267
-12383
File diff suppressed because it is too large
Load Diff
+18409
-12384
File diff suppressed because it is too large
Load Diff
@@ -1,17 +1,18 @@
|
|||||||
overlay: 1.0.0
|
overlay: 1.0.0
|
||||||
x-speakeasy-jsonpath: rfc9535
|
x-speakeasy-jsonpath: rfc9535
|
||||||
info:
|
info:
|
||||||
title: Add HTTP-Referer and X-Title as global parameters
|
title: Add HTTP-Referer and X-OpenRouter-Title as global parameters
|
||||||
version: 0.0.0
|
version: 0.0.0
|
||||||
actions:
|
actions:
|
||||||
# Add global parameters for app identification
|
# Add global parameters for app identification
|
||||||
- target: $
|
- target: $
|
||||||
description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
|
description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers
|
||||||
update:
|
update:
|
||||||
x-speakeasy-globals:
|
x-speakeasy-globals:
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/AppIdentifier"
|
- $ref: "#/components/parameters/AppIdentifier"
|
||||||
- $ref: "#/components/parameters/AppDisplayName"
|
- $ref: "#/components/parameters/AppDisplayName"
|
||||||
|
- $ref: "#/components/parameters/AppCategories"
|
||||||
|
|
||||||
# Add component parameters
|
# Add component parameters
|
||||||
- target: $.components
|
- target: $.components
|
||||||
@@ -27,9 +28,25 @@ actions:
|
|||||||
The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
The app identifier should be your app's URL and is used as the primary identifier for rankings.
|
||||||
This is used to track API usage per application.
|
This is used to track API usage per application.
|
||||||
AppDisplayName:
|
AppDisplayName:
|
||||||
name: X-Title
|
name: X-OpenRouter-Title
|
||||||
in: header
|
in: header
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
The app display name allows you to customize how your app appears in OpenRouter's dashboard.
|
||||||
|
AppCategories:
|
||||||
|
name: X-OpenRouter-Categories
|
||||||
|
in: header
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
|
||||||
|
|
||||||
|
# Add header parameters to all paths so Speakeasy matches them with globals
|
||||||
|
- target: $.paths[*]
|
||||||
|
description: Reference app identification headers on all paths so Speakeasy injects them via globals
|
||||||
|
update:
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/AppIdentifier"
|
||||||
|
- $ref: "#/components/parameters/AppDisplayName"
|
||||||
|
- $ref: "#/components/parameters/AppCategories"
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
overlay: 1.0.0
|
||||||
|
x-speakeasy-jsonpath: rfc9535
|
||||||
|
info:
|
||||||
|
title: Simplify redundant allOf inline schemas
|
||||||
|
version: 0.0.0
|
||||||
|
actions:
|
||||||
|
- target: "$..allOf[?@.enum && !@['$ref']]"
|
||||||
|
description: >
|
||||||
|
Remove inline enum definitions that duplicate a $ref enum in the same
|
||||||
|
allOf. These are artifacts from zod-openapi .extend() serialization.
|
||||||
|
remove: true
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
overlay: 1.0.0
|
||||||
|
x-speakeasy-jsonpath: rfc9535
|
||||||
|
info:
|
||||||
|
title: Convert boolean query params from string to boolean
|
||||||
|
version: 0.0.0
|
||||||
|
actions:
|
||||||
|
- target: $..parameters[?@.schema["x-openrouter-type"] == "boolean"].schema
|
||||||
|
description: Convert x-openrouter-type boolean params from string to boolean
|
||||||
|
update:
|
||||||
|
type: boolean
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
overlay: 1.0.0
|
||||||
|
x-speakeasy-jsonpath: rfc9535
|
||||||
|
info:
|
||||||
|
title: Fix nullable pagination params
|
||||||
|
version: 0.0.0
|
||||||
|
actions:
|
||||||
|
- target: $..parameters[?@.name == "offset" && @.in == "query"].schema
|
||||||
|
description: Remove nullable from offset query params to fix mypy errors in pagination helpers
|
||||||
|
update:
|
||||||
|
nullable: false
|
||||||
+10
-14
@@ -1,30 +1,23 @@
|
|||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
-OAS:
|
|
||||||
sourceNamespace: open-router-chat-completions-api
|
|
||||||
sourceRevisionDigest: sha256:01256c8494de6bfc13c36d82ae316a6a13d402194f844618bcd4d59e34f325f3
|
|
||||||
sourceBlobDigest: sha256:4c80e48fd5e1cd030e68d664eb93984b4d5946867252ff1755a2bd2a05eccd4e
|
|
||||||
tags:
|
|
||||||
- latest
|
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:5ba48c1ff7f13c2c5d9ab558e9ecd4638b65c12dd9c4e0cff7fb337674e94ceb
|
sourceRevisionDigest: sha256:3982892b2b8f82bfc2a26a0f6fcc9512b665a1051dc240a9cfa29001b9453aa9
|
||||||
sourceBlobDigest: sha256:082db9694677b85116bda99811c8b957f96d1c493a3c606643479a65dad79730
|
sourceBlobDigest: sha256:727d3c1f7d36ffbf94c57b565536d8a16804eaef4c4043dd6c98152fc1629c8f
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
|
||||||
- 1.0.0
|
- 1.0.0
|
||||||
targets:
|
targets:
|
||||||
open-router:
|
open-router:
|
||||||
source: OpenRouter API
|
source: OpenRouter API
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:5ba48c1ff7f13c2c5d9ab558e9ecd4638b65c12dd9c4e0cff7fb337674e94ceb
|
sourceRevisionDigest: sha256:3982892b2b8f82bfc2a26a0f6fcc9512b665a1051dc240a9cfa29001b9453aa9
|
||||||
sourceBlobDigest: sha256:082db9694677b85116bda99811c8b957f96d1c493a3c606643479a65dad79730
|
sourceBlobDigest: sha256:727d3c1f7d36ffbf94c57b565536d8a16804eaef4c4043dd6c98152fc1629c8f
|
||||||
codeSamplesNamespace: open-router-python-code-samples
|
codeSamplesNamespace: open-router-python-code-samples
|
||||||
codeSamplesRevisionDigest: sha256:116feda356a202c5508dfe68daec83b7a490e6c311f6829eda3729cae7256e6d
|
codeSamplesRevisionDigest: sha256:db86aed74d199f265e2e20442ef652dac0911c8a657ccb3e6614d56a26b8b44e
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -33,6 +26,9 @@ workflow:
|
|||||||
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
||||||
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
||||||
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/allof-simplify.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/boolean-query-params.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/fix-nullable-pagination.overlay.yaml
|
||||||
output: .speakeasy/out.openapi.yaml
|
output: .speakeasy/out.openapi.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
@@ -8,6 +8,9 @@ sources:
|
|||||||
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
- location: .speakeasy/overlays/open-enums.overlay.yaml
|
||||||
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
|
||||||
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
- location: .speakeasy/overlays/add-headers.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/allof-simplify.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/boolean-query-params.overlay.yaml
|
||||||
|
- location: .speakeasy/overlays/fix-nullable-pagination.overlay.yaml
|
||||||
output: .speakeasy/out.openapi.yaml
|
output: .speakeasy/out.openapi.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||||
|
|||||||
@@ -182,6 +182,9 @@ import os
|
|||||||
def main():
|
def main():
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -191,6 +194,9 @@ def main():
|
|||||||
async def amain():
|
async def amain():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
|
|||||||
@@ -169,6 +169,36 @@ asyncio.run(main())
|
|||||||
|
|
||||||
<!-- No Custom HTTP Client [http-client] -->
|
<!-- No Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
|
<!-- Start Pagination [pagination] -->
|
||||||
|
## Pagination
|
||||||
|
|
||||||
|
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
|
||||||
|
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
|
||||||
|
return value of `Next` is `None`, then there are no more pages to be fetched.
|
||||||
|
|
||||||
|
Here's an example of one such pagination call:
|
||||||
|
```python
|
||||||
|
from openrouter import OpenRouter
|
||||||
|
import os
|
||||||
|
|
||||||
|
|
||||||
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
|
) as open_router:
|
||||||
|
|
||||||
|
res = open_router.guardrails.list()
|
||||||
|
|
||||||
|
while res is not None:
|
||||||
|
# Handle items
|
||||||
|
|
||||||
|
res = res.next()
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Pagination [pagination] -->
|
||||||
|
|
||||||
<!-- Start Resource Management [resource-management] -->
|
<!-- Start Resource Management [resource-management] -->
|
||||||
## Resource Management
|
## Resource Management
|
||||||
|
|
||||||
@@ -182,6 +212,9 @@ import os
|
|||||||
def main():
|
def main():
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
@@ -191,6 +224,9 @@ def main():
|
|||||||
async def amain():
|
async def amain():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
# Rest of application here...
|
# Rest of application here...
|
||||||
|
|||||||
@@ -6,15 +6,16 @@ import os
|
|||||||
|
|
||||||
|
|
||||||
with OpenRouter(
|
with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
res = open_router.beta.responses.send(service_tier="auto", stream=False)
|
res = open_router.analytics.get_user_activity()
|
||||||
|
|
||||||
with res as event_stream:
|
# Handle response
|
||||||
for event in event_stream:
|
print(res)
|
||||||
# handle event
|
|
||||||
print(event, flush=True)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
</br>
|
</br>
|
||||||
@@ -30,15 +31,16 @@ import os
|
|||||||
async def main():
|
async def main():
|
||||||
|
|
||||||
async with OpenRouter(
|
async with OpenRouter(
|
||||||
|
http_referer="<value>",
|
||||||
|
x_open_router_title="<value>",
|
||||||
|
x_open_router_categories="<value>",
|
||||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||||
) as open_router:
|
) as open_router:
|
||||||
|
|
||||||
res = await open_router.beta.responses.send_async(service_tier="auto", stream=False)
|
res = await open_router.analytics.get_user_activity_async()
|
||||||
|
|
||||||
async with res as event_stream:
|
# Handle response
|
||||||
async for event in event_stream:
|
print(res)
|
||||||
# handle event
|
|
||||||
print(event, flush=True)
|
|
||||||
|
|
||||||
asyncio.run(main())
|
asyncio.run(main())
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -5,14 +5,14 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 |
|
||||||
|
| `completion_tokens` | *int* | :heavy_check_mark: | Total completion tokens generated | 125 |
|
||||||
| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 |
|
| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 |
|
||||||
|
| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 |
|
||||||
| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 |
|
| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 |
|
||||||
| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 |
|
| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 |
|
||||||
| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 |
|
| `prompt_tokens` | *int* | :heavy_check_mark: | Total prompt tokens used | 50 |
|
||||||
| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI |
|
| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI |
|
||||||
|
| `reasoning_tokens` | *int* | :heavy_check_mark: | Total reasoning tokens used | 25 |
|
||||||
|
| `requests` | *int* | :heavy_check_mark: | Number of requests made | 5 |
|
||||||
| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 |
|
| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 |
|
||||||
| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 |
|
|
||||||
| `requests` | *float* | :heavy_check_mark: | Number of requests made | 5 |
|
|
||||||
| `prompt_tokens` | *float* | :heavy_check_mark: | Total prompt tokens used | 50 |
|
|
||||||
| `completion_tokens` | *float* | :heavy_check_mark: | Total completion tokens generated | 125 |
|
|
||||||
| `reasoning_tokens` | *float* | :heavy_check_mark: | Total reasoning tokens used | 25 |
|
|
||||||
@@ -7,8 +7,8 @@ Model architecture information
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
| `tokenizer` | [Nullable[components.Tokenizer]](../components/tokenizer.md) | :heavy_check_mark: | N/A | GPT |
|
|
||||||
| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.md) | :heavy_check_mark: | Instruction format type | |
|
|
||||||
| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text |
|
|
||||||
| `input_modalities` | List[[components.InputModality](../components/inputmodality.md)] | :heavy_check_mark: | Supported input modalities | |
|
| `input_modalities` | List[[components.InputModality](../components/inputmodality.md)] | :heavy_check_mark: | Supported input modalities | |
|
||||||
|
| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.md) | :heavy_check_mark: | Instruction format type | chatml |
|
||||||
|
| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text |
|
||||||
| `output_modalities` | List[[components.OutputModality](../components/outputmodality.md)] | :heavy_check_mark: | Supported output modalities | |
|
| `output_modalities` | List[[components.OutputModality](../components/outputmodality.md)] | :heavy_check_mark: | Supported output modalities | |
|
||||||
|
| `tokenizer` | [Nullable[components.Tokenizer]](../components/tokenizer.md) | :heavy_check_mark: | N/A | GPT |
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# AssistantMessage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
||||||
| `role` | *Literal["assistant"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning_details` | List[[components.Schema2](../components/schema2.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `images` | List[[components.Image](../components/image.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# AssistantMessageContent
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[components.ChatMessageContentItem]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[components.ChatMessageContentItem] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# AssistantMessageImageURL
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `url` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,4 +1,6 @@
|
|||||||
# Sort
|
# By
|
||||||
|
|
||||||
|
The provider sorting strategy (price, throughput, latency)
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -8,3 +10,4 @@
|
|||||||
| `PRICE` | price |
|
| `PRICE` | price |
|
||||||
| `THROUGHPUT` | throughput |
|
| `THROUGHPUT` | throughput |
|
||||||
| `LATENCY` | latency |
|
| `LATENCY` | latency |
|
||||||
|
| `EXACTO` | exacto |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChainID
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------------------------------------------- | --------------------------------------------- |
|
|
||||||
| `ONE` | 1 |
|
|
||||||
| `ONE_HUNDRED_AND_THIRTY_SEVEN` | 137 |
|
|
||||||
| `EIGHT_THOUSAND_FOUR_HUNDRED_AND_FIFTY_THREE` | 8453 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# ChatCompletionFinishReason
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `TOOL_CALLS` | tool_calls |
|
|
||||||
| `STOP` | stop |
|
|
||||||
| `LENGTH` | length |
|
|
||||||
| `CONTENT_FILTER` | content_filter |
|
|
||||||
| `ERROR` | error |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatErrorError
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
||||||
| `code` | [Nullable[components.Code]](../components/code.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `message` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `param` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
# ChatGenerationParams
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `provider` | [OptionalNullable[components.ChatGenerationParamsProvider]](../components/chatgenerationparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. |
|
|
||||||
| `plugins` | List[[components.ChatGenerationParamsPluginUnion](../components/chatgenerationparamspluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. |
|
|
||||||
| `route` | [OptionalNullable[components.Route]](../components/route.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `session_id` | *Optional[str]* | :heavy_minus_sign: | 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. |
|
|
||||||
| `messages` | List[[components.Message](../components/message.md)] | :heavy_check_mark: | N/A |
|
|
||||||
| `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `models` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `stop` | [OptionalNullable[components.Stop]](../components/stop.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `tools` | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `debug` | [Optional[components.Debug]](../components/debug.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatGenerationParamsDataCollection
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------- | ------- |
|
|
||||||
| `DENY` | deny |
|
|
||||||
| `ALLOW` | allow |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatGenerationParamsEngine
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------- | -------- |
|
|
||||||
| `NATIVE` | native |
|
|
||||||
| `EXA` | exa |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatGenerationParamsImageConfig
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# ChatGenerationParamsMaxPrice
|
|
||||||
|
|
||||||
The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `prompt` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `completion` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `image` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `audio` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `request` | *Optional[Any]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatGenerationParamsPdf
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
||||||
| `engine` | [Optional[components.ChatGenerationParamsPdfEngine]](../components/chatgenerationparamspdfengine.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatGenerationParamsPdfEngine
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `MISTRAL_OCR` | mistral-ocr |
|
|
||||||
| `PDF_TEXT` | pdf-text |
|
|
||||||
| `NATIVE` | native |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginAutoRouter
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `id` | *Literal["auto-router"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `allowed_models` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginFileParser
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
|
||||||
| `id` | *Literal["file-parser"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `pdf` | [Optional[components.Pdf]](../components/pdf.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginModeration
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
|
||||||
| `id` | *Literal["moderation"]* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginResponseHealing
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
|
||||||
| `id` | *Literal["response-healing"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginAutoRouter`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginAutoRouter = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginModeration`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginModeration = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginWeb`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginWeb = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginFileParser`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginFileParser = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPluginResponseHealing`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# ChatGenerationParamsPluginWeb
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
|
||||||
| `id` | *Literal["web"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `engine` | [Optional[components.Engine]](../components/engine.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMaxLatency
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
|
||||||
| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMaxLatencyUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPreferredMaxLatency`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPreferredMaxLatency = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMinThroughput
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
|
||||||
| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatGenerationParamsPreferredMinThroughputUnion
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatGenerationParamsPreferredMinThroughput`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatGenerationParamsPreferredMinThroughput = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# ChatGenerationParamsProvider
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `allow_fallbacks` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to allow backup providers to serve requests<br/>- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.<br/>- false: use only the primary/custom provider, and return the upstream error if it's unavailable.<br/> |
|
|
||||||
| `require_parameters` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. |
|
|
||||||
| `data_collection` | [OptionalNullable[components.ChatGenerationParamsDataCollection]](../components/chatgenerationparamsdatacollection.md) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.<br/>- allow: (default) allow providers which store user data non-transiently and may train on it<br/><br/>- deny: use only providers which do not collect user data. |
|
|
||||||
| `zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `enforce_distillable_text` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `order` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. |
|
|
||||||
| `only` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. |
|
|
||||||
| `ignore` | List[[components.Schema0](../components/schema0.md)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. |
|
|
||||||
| `quantizations` | List[[components.Quantizations](../components/quantizations.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. |
|
|
||||||
| `sort` | [OptionalNullable[components.ProviderSortUnion]](../components/providersortunion.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. |
|
|
||||||
| `max_price` | [Optional[components.ChatGenerationParamsMaxPrice]](../components/chatgenerationparamsmaxprice.md) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. |
|
|
||||||
| `preferred_min_throughput` | [OptionalNullable[components.ChatGenerationParamsPreferredMinThroughputUnion]](../components/chatgenerationparamspreferredminthroughputunion.md) | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. |
|
|
||||||
| `preferred_max_latency` | [OptionalNullable[components.ChatGenerationParamsPreferredMaxLatencyUnion]](../components/chatgenerationparamspreferredmaxlatencyunion.md) | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatGenerationParamsRoute
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------- | ---------- |
|
|
||||||
| `FALLBACK` | fallback |
|
|
||||||
| `SORT` | sort |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# ChatGenerationTokenUsage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
||||||
| `completion_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `prompt_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `total_tokens` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `completion_tokens_details` | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `prompt_tokens_details` | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# ChatMessageContentItem
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemImage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemImage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemAudio`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemAudio = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemVideo`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemVideo = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemVideo`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemVideo = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemAudio
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | *Literal["input_audio"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `input_audio` | [components.ChatMessageContentItemAudioInputAudio](../components/chatmessagecontentitemaudioinputaudio.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemAudioInputAudio
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `data` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `format_` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemCacheControl
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
|
||||||
| `type` | *Literal["ephemeral"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemImage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `type` | *Literal["image_url"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `image_url` | [components.ChatMessageContentItemImageImageURL](../components/chatmessagecontentitemimageimageurl.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatMessageContentItemImageDetail
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `AUTO` | auto |
|
|
||||||
| `LOW` | low |
|
|
||||||
| `HIGH` | high |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemImageImageURL
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `url` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `detail` | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatMessageContentItemText
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | *Literal["text"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `text` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `cache_control` | [Optional[components.ChatMessageContentItemCacheControl]](../components/chatmessagecontentitemcachecontrol.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# ChatMessageContentItemVideo
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemVideoInputVideo`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemVideoInputVideo = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ChatMessageContentItemVideoVideoURL`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemVideoVideoURL = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemVideoInputVideo
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
||||||
| `type` | *Literal["input_video"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `video_url` | [components.VideoURL1](../components/videourl1.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemVideoVideoURL
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
||||||
| `type` | *Literal["video_url"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `video_url` | [components.VideoURL2](../components/videourl2.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatMessageTokenLogprob
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `token` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `logprob` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `bytes_` | List[*float*] | :heavy_check_mark: | N/A |
|
|
||||||
| `top_logprobs` | List[[components.ChatMessageTokenLogprobTopLogprob](../components/chatmessagetokenlogprobtoplogprob.md)] | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageTokenLogprobs
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
||||||
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | N/A |
|
|
||||||
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatMessageTokenLogprobTopLogprob
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `token` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `logprob` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `bytes_` | List[*float*] | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# ChatMessageToolCall
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `type` | *Literal["function"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `function` | [components.ChatMessageToolCallFunction](../components/chatmessagetoolcallfunction.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageToolCallFunction
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `name` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `arguments` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# ChatResponse
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `id` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `choices` | List[[components.ChatResponseChoice](../components/chatresponsechoice.md)] | :heavy_check_mark: | N/A |
|
|
||||||
| `created` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `model` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `object` | *Literal["chat.completion"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatResponseChoice
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
||||||
| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `message` | [components.AssistantMessage](../components/assistantmessage.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatStreamingChoice
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
||||||
| `delta` | [components.ChatStreamingMessageChunk](../components/chatstreamingmessagechunk.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# ChatStreamingMessageChunk
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
||||||
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
| `reasoning_details` | List[[components.Schema2](../components/schema2.md)] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatStreamingMessageChunkRole
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `ASSISTANT` | assistant |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# ChatStreamingMessageToolCall
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `type` | *Optional[Literal["function"]]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `function` | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatStreamingMessageToolCallFunction
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `arguments` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatStreamingResponseChunk
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `data` | [components.ChatStreamingResponseChunkData](../components/chatstreamingresponsechunkdata.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# ChatStreamingResponseChunkData
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `choices` | List[[components.ChatStreamingChoice](../components/chatstreamingchoice.md)] | :heavy_check_mark: | N/A |
|
|
||||||
| `created` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `model` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `object` | *Literal["chat.completion.chunk"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `error` | [Optional[components.ChatStreamingResponseChunkError]](../components/chatstreamingresponsechunkerror.md) | :heavy_minus_sign: | N/A |
|
|
||||||
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatStreamingResponseChunkError
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `message` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `code` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
# ChatStreamOptions
|
# ChatStreamOptions
|
||||||
|
|
||||||
|
Streaming configuration options
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `include_usage` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
| ~~`include_usage`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated: This field has no effect. Full usage details are always included. | true |
|
||||||
+21
-13
@@ -1,17 +1,25 @@
|
|||||||
# Code
|
# Code
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Values
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `float`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: float = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------- | -------------------------------- |
|
||||||
|
| `SERVER_ERROR` | server_error |
|
||||||
|
| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded |
|
||||||
|
| `INVALID_PROMPT` | invalid_prompt |
|
||||||
|
| `VECTOR_STORE_TIMEOUT` | vector_store_timeout |
|
||||||
|
| `INVALID_IMAGE` | invalid_image |
|
||||||
|
| `INVALID_IMAGE_FORMAT` | invalid_image_format |
|
||||||
|
| `INVALID_BASE64_IMAGE` | invalid_base64_image |
|
||||||
|
| `INVALID_IMAGE_URL` | invalid_image_url |
|
||||||
|
| `IMAGE_TOO_LARGE` | image_too_large |
|
||||||
|
| `IMAGE_TOO_SMALL` | image_too_small |
|
||||||
|
| `IMAGE_PARSE_ERROR` | image_parse_error |
|
||||||
|
| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation |
|
||||||
|
| `INVALID_IMAGE_MODE` | invalid_image_mode |
|
||||||
|
| `IMAGE_FILE_TOO_LARGE` | image_file_too_large |
|
||||||
|
| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type |
|
||||||
|
| `EMPTY_IMAGE_FILE` | empty_image_file |
|
||||||
|
| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image |
|
||||||
|
| `IMAGE_FILE_NOT_FOUND` | image_file_not_found |
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# CodeEnum
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------------------------- | -------------------------------- |
|
|
||||||
| `SERVER_ERROR` | server_error |
|
|
||||||
| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded |
|
|
||||||
| `INVALID_PROMPT` | invalid_prompt |
|
|
||||||
| `VECTOR_STORE_TIMEOUT` | vector_store_timeout |
|
|
||||||
| `INVALID_IMAGE` | invalid_image |
|
|
||||||
| `INVALID_IMAGE_FORMAT` | invalid_image_format |
|
|
||||||
| `INVALID_BASE64_IMAGE` | invalid_base64_image |
|
|
||||||
| `INVALID_IMAGE_URL` | invalid_image_url |
|
|
||||||
| `IMAGE_TOO_LARGE` | image_too_large |
|
|
||||||
| `IMAGE_TOO_SMALL` | image_too_small |
|
|
||||||
| `IMAGE_PARSE_ERROR` | image_parse_error |
|
|
||||||
| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation |
|
|
||||||
| `INVALID_IMAGE_MODE` | invalid_image_mode |
|
|
||||||
| `IMAGE_FILE_TOO_LARGE` | image_file_too_large |
|
|
||||||
| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type |
|
|
||||||
| `EMPTY_IMAGE_FILE` | empty_image_file |
|
|
||||||
| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image |
|
|
||||||
| `IMAGE_FILE_NOT_FOUND` | image_file_not_found |
|
|
||||||
@@ -1,11 +1,13 @@
|
|||||||
# CompletionTokensDetails
|
# CompletionTokensDetails
|
||||||
|
|
||||||
|
Detailed completion token usage
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
||||||
| `reasoning_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `accepted_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Accepted prediction tokens |
|
||||||
| `audio_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for audio output |
|
||||||
| `accepted_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for reasoning |
|
||||||
| `rejected_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `rejected_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Rejected prediction tokens |
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# CreateChargeRequest
|
|
||||||
|
|
||||||
Create a Coinbase charge for crypto payment
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
|
||||||
| `amount` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `sender` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `chain_id` | [components.ChainID](../components/chainid.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# ModelsCountResponseData
|
# Data
|
||||||
|
|
||||||
Model count data
|
Model count data
|
||||||
|
|
||||||
@@ -7,4 +7,4 @@ Model count data
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
| `count` | *float* | :heavy_check_mark: | Total number of available models | 150 |
|
| `count` | *int* | :heavy_check_mark: | Total number of available models | 150 |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Debug
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------- | -------------------- | -------------------- | -------------------- |
|
|
||||||
| `echo_upstream_body` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -7,6 +7,9 @@ Default parameters for this model
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
# Effort
|
# Effort
|
||||||
|
|
||||||
|
Constrains effort on reasoning for reasoning models
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
# Engine
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------- | -------- |
|
|
||||||
| `NATIVE` | native |
|
|
||||||
| `EXA` | exa |
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Error
|
||||||
|
|
||||||
|
Error information
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `code` | *int* | :heavy_check_mark: | Error code | 429 |
|
||||||
|
| `message` | *str* | :heavy_check_mark: | Error message | Rate limit exceeded |
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
| `type` | [components.FileCitationType](../components/filecitationtype.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `file_id` | *str* | :heavy_check_mark: | N/A |
|
| `file_id` | *str* | :heavy_check_mark: | N/A |
|
||||||
| `filename` | *str* | :heavy_check_mark: | N/A |
|
| `filename` | *str* | :heavy_check_mark: | N/A |
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
| `index` | *int* | :heavy_check_mark: | N/A |
|
||||||
|
| `type` | [components.FileCitationType](../components/filecitationtype.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -5,6 +5,6 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
| `type` | [components.FilePathType](../components/filepathtype.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `file_id` | *str* | :heavy_check_mark: | N/A |
|
| `file_id` | *str* | :heavy_check_mark: | N/A |
|
||||||
| `index` | *float* | :heavy_check_mark: | N/A |
|
| `index` | *int* | :heavy_check_mark: | N/A |
|
||||||
|
| `type` | [components.FilePathType](../components/filepathtype.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# IDAutoRouter
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `AUTO_ROUTER` | auto-router |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# IDFileParser
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `FILE_PARSER` | file-parser |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# IDModeration
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `MODERATION` | moderation |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# IDResponseHealing
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------ | ------------------ |
|
|
||||||
| `RESPONSE_HEALING` | response-healing |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# IDWeb
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----- | ----- |
|
|
||||||
| `WEB` | web |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# Ignore
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ProviderName`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ProviderName = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Image
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
||||||
| `image_url` | [components.AssistantMessageImageURL](../components/assistantmessageimageurl.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `cached_tokens` | *float* | :heavy_check_mark: | N/A |
|
| `cached_tokens` | *int* | :heavy_check_mark: | N/A |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# JSONSchemaConfig
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
||||||
| `name` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `description` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `schema_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -7,9 +7,9 @@ List of available endpoints for a model
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `architecture` | [components.Architecture](../components/architecture.md) | :heavy_check_mark: | N/A | {<br/>"input_modalities": [<br/>"text"<br/>],<br/>"instruct_type": "chatml",<br/>"modality": "text-\u003etext",<br/>"output_modalities": [<br/>"text"<br/>],<br/>"tokenizer": "GPT"<br/>} |
|
||||||
|
| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 |
|
||||||
|
| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. |
|
||||||
|
| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.md)] | :heavy_check_mark: | List of available endpoints for this model | |
|
||||||
| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 |
|
| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 |
|
||||||
| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 |
|
| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 |
|
||||||
| `created` | *float* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 |
|
|
||||||
| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. |
|
|
||||||
| `architecture` | [components.Architecture](../components/architecture.md) | :heavy_check_mark: | N/A | {<br/>"tokenizer": "GPT",<br/>"instruct_type": "chatml",<br/>"modality": "text-\u003etext",<br/>"input_modalities": [<br/>"text"<br/>],<br/>"output_modalities": [<br/>"text"<br/>]<br/>} |
|
|
||||||
| `endpoints` | List[[components.PublicEndpoint](../components/publicendpoint.md)] | :heavy_check_mark: | List of available endpoints for this model | |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# Logprob
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `token` | *str* | :heavy_check_mark: | N/A |
|
|
||||||
| `bytes_` | List[*float*] | :heavy_check_mark: | N/A |
|
|
||||||
| `logprob` | *float* | :heavy_check_mark: | N/A |
|
|
||||||
| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](../components/responseoutputtexttoplogprob.md)] | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# Message
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.SystemMessage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.SystemMessage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.UserMessage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.UserMessage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.MessageDeveloper`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.MessageDeveloper = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.AssistantMessage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.AssistantMessage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ToolResponseMessage`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ToolResponseMessage = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# MessageContent
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[components.ChatMessageContentItemText]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[components.ChatMessageContentItemText] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# MessageDeveloper
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
||||||
| `role` | *Literal["developer"]* | :heavy_check_mark: | N/A |
|
|
||||||
| `content` | [components.MessageContent](../components/messagecontent.md) | :heavy_check_mark: | N/A |
|
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -7,3 +7,4 @@
|
|||||||
| ------- | ------- |
|
| ------- | ------- |
|
||||||
| `TEXT` | text |
|
| `TEXT` | text |
|
||||||
| `IMAGE` | image |
|
| `IMAGE` | image |
|
||||||
|
| `AUDIO` | audio |
|
||||||
+13
-11
@@ -7,17 +7,19 @@ Information about an AI model available on OpenRouter
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 |
|
| `architecture` | [components.ModelArchitecture](../components/modelarchitecture.md) | :heavy_check_mark: | Model architecture information | {<br/>"input_modalities": [<br/>"text"<br/>],<br/>"instruct_type": "chatml",<br/>"modality": "text-\u003etext",<br/>"output_modalities": [<br/>"text"<br/>],<br/>"tokenizer": "GPT"<br/>} |
|
||||||
| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 |
|
| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 |
|
||||||
| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium |
|
| `context_length` | *Nullable[int]* | :heavy_check_mark: | Maximum context length in tokens | 8192 |
|
||||||
| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 |
|
| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 |
|
||||||
| `created` | *float* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 |
|
| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"frequency_penalty": 0,<br/>"presence_penalty": 0,<br/>"repetition_penalty": 1,<br/>"temperature": 0.7,<br/>"top_k": 0,<br/>"top_p": 0.9<br/>} |
|
||||||
| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. |
|
| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. |
|
||||||
| `pricing` | [components.PublicPricing](../components/publicpricing.md) | :heavy_check_mark: | Pricing information for the model | {<br/>"prompt": "0.00003",<br/>"completion": "0.00006",<br/>"request": "0",<br/>"image": "0"<br/>} |
|
|
||||||
| `context_length` | *Nullable[float]* | :heavy_check_mark: | Maximum context length in tokens | 8192 |
|
|
||||||
| `architecture` | [components.ModelArchitecture](../components/modelarchitecture.md) | :heavy_check_mark: | Model architecture information | {<br/>"tokenizer": "GPT",<br/>"instruct_type": "chatml",<br/>"modality": "text-\u003etext",<br/>"input_modalities": [<br/>"text"<br/>],<br/>"output_modalities": [<br/>"text"<br/>]<br/>} |
|
|
||||||
| `top_provider` | [components.TopProviderInfo](../components/topproviderinfo.md) | :heavy_check_mark: | Information about the top provider for this model | {<br/>"context_length": 8192,<br/>"max_completion_tokens": 4096,<br/>"is_moderated": true<br/>} |
|
|
||||||
| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | {<br/>"prompt_tokens": 1000,<br/>"completion_tokens": 1000<br/>} |
|
|
||||||
| `supported_parameters` | List[[components.Parameter](../components/parameter.md)] | :heavy_check_mark: | List of supported parameters for this model | |
|
|
||||||
| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"frequency_penalty": 0<br/>} |
|
|
||||||
| `expiration_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 |
|
| `expiration_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 |
|
||||||
|
| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 |
|
||||||
|
| `knowledge_cutoff` | *OptionalNullable[str]* | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 |
|
||||||
|
| `links` | [components.ModelLinks](../components/modellinks.md) | :heavy_check_mark: | Related API endpoints and resources for this model. | {<br/>"details": "/api/v1/models/openai/gpt-5.4/endpoints"<br/>} |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 |
|
||||||
|
| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | {<br/>"completion_tokens": 1000,<br/>"prompt_tokens": 1000<br/>} |
|
||||||
|
| `pricing` | [components.PublicPricing](../components/publicpricing.md) | :heavy_check_mark: | Pricing information for the model | {<br/>"completion": "0.00006",<br/>"image": "0",<br/>"prompt": "0.00003",<br/>"request": "0"<br/>} |
|
||||||
|
| `supported_parameters` | List[[components.Parameter](../components/parameter.md)] | :heavy_check_mark: | List of supported parameters for this model | |
|
||||||
|
| `top_provider` | [components.TopProviderInfo](../components/topproviderinfo.md) | :heavy_check_mark: | Information about the top provider for this model | {<br/>"context_length": 8192,<br/>"is_moderated": true,<br/>"max_completion_tokens": 4096<br/>} |
|
||||||
@@ -7,8 +7,8 @@ Model architecture information
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.md) | :heavy_minus_sign: | Tokenizer type used by the model | GPT |
|
| `input_modalities` | List[[components.InputModality](../components/inputmodality.md)] | :heavy_check_mark: | Supported input modalities | |
|
||||||
| `instruct_type` | [OptionalNullable[components.ModelArchitectureInstructType]](../components/modelarchitectureinstructtype.md) | :heavy_minus_sign: | Instruction format type | chatml |
|
| `instruct_type` | [OptionalNullable[components.ModelArchitectureInstructType]](../components/modelarchitectureinstructtype.md) | :heavy_minus_sign: | Instruction format type | chatml |
|
||||||
| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text |
|
| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text |
|
||||||
| `input_modalities` | List[[components.InputModality](../components/inputmodality.md)] | :heavy_check_mark: | Supported input modalities | |
|
|
||||||
| `output_modalities` | List[[components.OutputModality](../components/outputmodality.md)] | :heavy_check_mark: | Supported output modalities | |
|
| `output_modalities` | List[[components.OutputModality](../components/outputmodality.md)] | :heavy_check_mark: | Supported output modalities | |
|
||||||
|
| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.md) | :heavy_minus_sign: | Tokenizer type used by the model | GPT |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user