fix: exclude .speakeasy/ on import to prevent gen.lock conflicts

feat: add copybara sync workflow for monorepo integration
2026-07-31 12:30:30 +08:00 · 2026-01-12 20:35:42 -05:00 · 2026-01-12 20:10:30 -05:00
1218 changed files with 34687 additions and 146475 deletions
@@ -1,86 +0,0 @@
-name: Auto-merge Speakeasy PR
-
-# Speakeasy mode:pr opens PRs (speakeasy-sdk-regen-*) and labels them
-# patch/minor/major. Merge automatically so sdk_publish.yaml can run.
-
-on:
-  pull_request:
-    types: [labeled]
-
-permissions:
-  contents: write
-  pull-requests: write
-
-concurrency:
-  group: auto-merge-speakeasy
-  cancel-in-progress: false
-
-jobs:
-  auto-merge:
-    if: |
-      github.event.sender.login == 'github-actions[bot]' &&
-      github.event.pull_request.user.login == 'github-actions[bot]' &&
-      startsWith(github.event.pull_request.head.ref, 'speakeasy-sdk-regen-') &&
-      contains(github.event.pull_request.title, '🐝 Update SDK') &&
-      contains(fromJSON('["patch", "minor", "major"]'), github.event.label.name)
-    runs-on: ubuntu-latest
-    steps:
-      - name: Close superseded Speakeasy PRs
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          set -euo pipefail
-          CURRENT_PR="${{ github.event.pull_request.number }}"
-
-          PRIOR_JSON=$(gh pr list \
-            --repo "${{ github.repository }}" \
-            --state open \
-            --search "head:speakeasy-sdk-regen-" \
-            --limit 500 \
-            --json number \
-            | jq -r --arg cur "$CURRENT_PR" \
-              '[.[].number | select(tostring != $cur)] | .[]')
-
-          if [ -z "$PRIOR_JSON" ]; then
-            echo "No superseded Speakeasy PRs to close"
-            exit 0
-          fi
-
-          mapfile -t PRIOR <<< "$PRIOR_JSON"
-
-          echo "Closing ${#PRIOR[@]} superseded Speakeasy PR(s)"
-          for N in "${PRIOR[@]}"; do
-            gh pr close "$N" --repo "${{ github.repository }}" --delete-branch \
-              --comment "Superseded by newer Speakeasy SDK generation PR #${CURRENT_PR}" \
-              || echo "::warning::Failed to close PR #$N (continuing)"
-            sleep 1
-          done
-
-      - name: Auto-merge Speakeasy PR
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          set -euo pipefail
-          PR_NUM="${{ github.event.pull_request.number }}"
-          REPO="${{ github.repository }}"
-
-          STATE=$(gh pr view "$PR_NUM" --repo "$REPO" --json state --jq .state)
-          if [ "$STATE" != "OPEN" ]; then
-            echo "PR #$PR_NUM is $STATE — skipping merge"
-            exit 0
-          fi
-
-          # Prefer GitHub auto-merge when required checks exist; otherwise
-          # squash-merge directly (same pattern as sdk-release-prs.yaml).
-          AUTO_MERGE_NOOP_PATTERN='is in clean status|protected branch rules|Branch does not have required protected branch rules'
-          if gh pr merge "$PR_NUM" --repo "$REPO" --squash --auto --delete-branch 2> /tmp/gh-merge.err; then
-            echo "Auto-merge enabled for Speakeasy PR #$PR_NUM"
-          elif grep -qiE "$AUTO_MERGE_NOOP_PATTERN" /tmp/gh-merge.err; then
-            echo "Auto-merge not applicable — merging PR #$PR_NUM directly"
-            cat /tmp/gh-merge.err >&2
-            gh pr merge "$PR_NUM" --repo "$REPO" --squash --delete-branch
-          else
-            echo "::error::Failed to enable auto-merge on Speakeasy PR #$PR_NUM"
-            cat /tmp/gh-merge.err >&2
-            exit 1
-          fi
@@ -0,0 +1,29 @@
+name: Copybara Sync to Monorepo
+
+on:
+  push:
+    branches: [main]
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
+
+      - name: Sync to Monorepo
+        uses: olivr/copybara-action@v1.2.5
+        with:
+          ssh_key: ${{ secrets.COPYBARA_SSH_KEY }}
+          access_token: ${{ secrets.MONOREPO_SYNC_TOKEN }}
+          sot_repo: OpenRouterTeam/python-sdk
+          destination_repo: OpenRouterTeam/openrouter-web
+          workflow: push
+          push_move: '||sdks/python||**'
+          # Exclude .speakeasy/ to preserve monorepo's gen.lock (contains repo-specific git hashes)
+          push_exclude: '.github/workflows/copybara-sync.yaml,.speakeasy'
+          copybara_options: ${{ github.event_name == 'pull_request_target' && '--force' || '' }}
@@ -1,36 +0,0 @@
-name: Generate (spec change merged)
-permissions:
-  checks: write
-  contents: write
-  pull-requests: write
-  statuses: write
-  id-token: write
-"on":
-  workflow_dispatch:
-    inputs:
-      force:
-        description: Force generation of SDKs
-        type: boolean
-        default: false
-      set_version:
-        description: optionally set a specific SDK version
-        type: string
-  pull_request:
-    types: [closed]
-    branches:
-      - main
-    paths:
-      - .speakeasy/in.openapi.yaml
-
-jobs:
-  generate:
-    if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
-    uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
-    with:
-      force: ${{ github.event.inputs.force }}
-      mode: pr
-      set_version: ${{ github.event.inputs.set_version }}
-    secrets:
-      github_access_token: ${{ secrets.GITHUB_TOKEN }}
-      pypi_token: ${{ secrets.PYPI_TOKEN }}
-      speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
@@ -1,25 +1,13 @@
+.venv/
 venv/
 src/*.egg-info/
 **/__pycache__/
 .pytest_cache/
 .python-version
+.DS_Store
 pyrightconfig.json
 **/.speakeasy/temp/
 **/.speakeasy/logs/
 .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.local
-.env.*.local
-.DS_Store
-.venv/
@@ -25,14 +25,13 @@ generation:
  schemas:
    allOfMergeStrategy: shallowMerge
  requestBodyFieldName: ""
-  persistentEdits: {}
  tests:
    generateTests: false
    generateNewTests: true
    skipResponseBodyAssertions: false
  preApplyUnionDiscriminators: true
 python:
-  version: 0.10.0
+  version: 0.0.17
  additionalDependencies:
    dev: {}
    main: {}
@@ -47,7 +46,6 @@ python:
    - OpenRouter
  baseErrorName: OpenRouterError
  clientServerStatusCodesAsErrors: true
-  constFieldCasing: upper
  defaultErrorName: OpenRouterDefaultError
  description: Official Python Client SDK for OpenRouter.
  enableCustomCodeRegions: false
@@ -59,7 +57,6 @@ python:
  flattenGlobalSecurity: true
  flattenRequests: true
  flatteningOrder: parameters-first
-  forwardCompatibleUnionsByDefault: tagged-only
  imports:
    option: openapi
    paths:
@@ -80,7 +77,6 @@ python:
  outputModelSuffix: output
  packageManager: uv
  packageName: openrouter
-  preApplyUnionDiscriminators: false
  pytestFilterWarnings: []
  pytestTimeout: 0
  responseFormat: flat
@@ -1,18 +1,17 @@
 overlay: 1.0.0
 x-speakeasy-jsonpath: rfc9535
 info:
-  title: Add HTTP-Referer and X-OpenRouter-Title as global parameters
+  title: Add HTTP-Referer and X-Title as global parameters
  version: 0.0.0
 actions:
  # Add global parameters for app identification
  - target: $
-    description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers
+    description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
    update:
      x-speakeasy-globals:
        parameters:
          - $ref: "#/components/parameters/AppIdentifier"
          - $ref: "#/components/parameters/AppDisplayName"
-          - $ref: "#/components/parameters/AppCategories"

  # Add component parameters
  - target: $.components
@@ -28,25 +27,9 @@ actions:
            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.
        AppDisplayName:
-          name: X-OpenRouter-Title
+          name: X-Title
          in: header
          schema:
            type: string
          description: |
            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"
@@ -1,11 +0,0 @@
-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
@@ -1,10 +0,0 @@
-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
@@ -1,10 +0,0 @@
-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
@@ -1,24 +1,29 @@
-speakeasyVersion: 1.680.0
+speakeasyVersion: 1.666.0
 sources:
-    OpenRouter API:
+    -OAS:
        sourceNamespace: open-router-chat-completions-api
-        sourceRevisionDigest: sha256:716ece4a1211eac2ee0e7e5836c7b484cff9bb002bd4e676d9ecad8317ee7941
-        sourceBlobDigest: sha256:12d3dc8e7150ab2c4c5e3d613b01cb5e4dcce52b329eea89ca1fdc656d6fe045
+        sourceRevisionDigest: sha256:01256c8494de6bfc13c36d82ae316a6a13d402194f844618bcd4d59e34f325f3
+        sourceBlobDigest: sha256:4c80e48fd5e1cd030e68d664eb93984b4d5946867252ff1755a2bd2a05eccd4e
+        tags:
+            - latest
+    OpenRouter API:
+        sourceNamespace: open-router-chat-completions-api
+        sourceRevisionDigest: sha256:92f6f1568ba089ae8e52bd55d859a97e446ae232c4c9ca9302ea64705313c7a0
+        sourceBlobDigest: sha256:6bbf6ab7123261f7e0604f1c640e32b5fc8fb6bb503b1bc8b12d0d78ed19fefc
        tags:
            - latest
-            - speakeasy-sdk-regen-1781312282
            - 1.0.0
 targets:
    open-router:
        source: OpenRouter API
        sourceNamespace: open-router-chat-completions-api
-        sourceRevisionDigest: sha256:716ece4a1211eac2ee0e7e5836c7b484cff9bb002bd4e676d9ecad8317ee7941
-        sourceBlobDigest: sha256:12d3dc8e7150ab2c4c5e3d613b01cb5e4dcce52b329eea89ca1fdc656d6fe045
+        sourceRevisionDigest: sha256:92f6f1568ba089ae8e52bd55d859a97e446ae232c4c9ca9302ea64705313c7a0
+        sourceBlobDigest: sha256:6bbf6ab7123261f7e0604f1c640e32b5fc8fb6bb503b1bc8b12d0d78ed19fefc
        codeSamplesNamespace: open-router-python-code-samples
-        codeSamplesRevisionDigest: sha256:e7d6f4de48a7c63cf15f3a8378f952277cd4c59373c28c61909497853fa769e2
+        codeSamplesRevisionDigest: sha256:8340c172a77ca9ffeeea6ca5dce0d69a084a3ba0a4e2e41d098759f546d80da4
 workflow:
    workflowVersion: 1.0.0
-    speakeasyVersion: 1.680.0
+    speakeasyVersion: 1.666.0
    sources:
        OpenRouter API:
            inputs:
@@ -27,9 +32,6 @@ workflow:
                - location: .speakeasy/overlays/open-enums.overlay.yaml
                - location: .speakeasy/overlays/remove-rss-responses.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
            registry:
                location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
@@ -1,5 +1,5 @@
 workflowVersion: 1.0.0
-speakeasyVersion: 1.680.0
+speakeasyVersion: 1.666.0
 sources:
    OpenRouter API:
        inputs:
@@ -8,9 +8,6 @@ sources:
            - location: .speakeasy/overlays/open-enums.overlay.yaml
            - location: .speakeasy/overlays/remove-rss-responses.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
        registry:
            location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
@@ -1,6 +1,6 @@
 # OpenRouter Python SDK

-The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 400+ language models through a unified API.
+The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API.

 ## Why use the OpenRouter SDK?

@@ -1,6 +1,6 @@
-# OpenRouter SDK
+# OpenRouter SDK (Beta)

-The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to 400+ models across providers in an easy and type-safe way.
+The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to over 300 models across providers in an easy and type-safe way.

 To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).

@@ -169,69 +169,6 @@ asyncio.run(main())

 <!-- 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.byok.list()
-
-    while res is not None:
-        # Handle items
-
-        res = res.next()
-
-```
-<!-- End Pagination [pagination] -->
-
-<!-- Start File uploads [file-upload] -->
-## File uploads
-
-Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
-
-> [!TIP]
->
-> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
->
-
-```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.files.upload(file={
-        "file_name": "example.file",
-        "content": open("example.file", "rb"),
-    })
-
-    # Handle response
-    print(res)
-
-```
-<!-- End File uploads [file-upload] -->
-
 <!-- Start Resource Management [resource-management] -->
 ## Resource Management

@@ -245,9 +182,6 @@ import os
 def main():

    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:
        # Rest of application here...
@@ -257,9 +191,6 @@ def main():
 async def amain():

    async 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:
        # Rest of application here...
@@ -309,4 +240,10 @@ To run the test suite, you'll need to set up your environment with an OpenRouter

   ```bash
   pytest
-   ```
+   ```
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version. 
@@ -1,6 +1,6 @@
-# OpenRouter SDK
+# OpenRouter SDK (Beta)

-The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to 400+ models across providers in an easy and type-safe way.
+The [OpenRouter SDK](https://openrouter.ai/docs/sdks/python) is a Python toolkit designed to help you build AI-powered features and solutions. Giving you easy access to over 300 models across providers in an easy and type-safe way.

 To learn more about how to use the OpenRouter SDK, check out our [API Reference](https://openrouter.ai/docs/sdks/python/reference) and [Documentation](https://openrouter.ai/docs/sdks/python).

@@ -169,69 +169,6 @@ asyncio.run(main())

 <!-- 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.byok.list()
-
-    while res is not None:
-        # Handle items
-
-        res = res.next()
-
-```
-<!-- End Pagination [pagination] -->
-
-<!-- Start File uploads [file-upload] -->
-## File uploads
-
-Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
-
-> [!TIP]
->
-> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
->
-
-```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.files.upload(file={
-        "file_name": "example.file",
-        "content": open("example.file", "rb"),
-    })
-
-    # Handle response
-    print(res)
-
-```
-<!-- End File uploads [file-upload] -->
-
 <!-- Start Resource Management [resource-management] -->
 ## Resource Management

@@ -245,9 +182,6 @@ import os
 def main():

    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:
        # Rest of application here...
@@ -257,9 +191,6 @@ def main():
 async def amain():

    async 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:
        # Rest of application here...
@@ -309,4 +240,10 @@ To run the test suite, you'll need to set up your environment with an OpenRouter

   ```bash
   pytest
-   ```
+   ```
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version. 
@@ -8,24 +8,4 @@ Based on:
 ### Generated
 - [python v0.0.16] .
 ### Releases
- [PyPI v0.0.16] https://pypi.org/project/openrouter/0.0.16 - .
-
-## 2026-06-11 00:55:55
-### Changes
-Based on:
- OpenAPI Doc  
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
-### Generated
- [python v0.9.2] .
-### Releases
- [PyPI v0.9.2] https://pypi.org/project/openrouter/0.9.2 - .
-
-## 2026-06-17 00:59:07
-### Changes
-Based on:
- OpenAPI Doc  
- Speakeasy CLI 1.680.0 (2.788.4) https://github.com/speakeasy-api/speakeasy
-### Generated
- [python v0.10.0] .
-### Releases
- [PyPI v0.10.0] https://pypi.org/project/openrouter/0.10.0 - .
+- [PyPI v0.0.16] https://pypi.org/project/openrouter/0.0.16 - .
@@ -6,16 +6,15 @@ 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.analytics.get_user_activity()
+    res = open_router.beta.responses.send(service_tier="auto", stream=False)

-    # Handle response
-    print(res)
+    with res as event_stream:
+        for event in event_stream:
+            # handle event
+            print(event, flush=True)
 ```

 </br>
@@ -31,16 +30,15 @@ import os
 async def main():

    async 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 = await open_router.analytics.get_user_activity_async()
+        res = await open_router.beta.responses.send_async(service_tier="auto", stream=False)

-        # Handle response
-        print(res)
+        async with res as event_stream:
+            async for event in event_stream:
+                # handle event
+                print(event, flush=True)

 asyncio.run(main())
 ```
@@ -5,14 +5,14 @@

 | 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                                          |
-| `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_permaslug`                                   | *str*                                               | :heavy_check_mark:                                  | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14                           |
-| `prompt_tokens`                                     | *int*                                               | :heavy_check_mark:                                  | Total prompt tokens used                            | 50                                                  |
+| `endpoint_id`                                       | *str*                                               | :heavy_check_mark:                                  | Unique identifier for the endpoint                  | 550e8400-e29b-41d4-a716-446655440000                |
 | `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                                                            |
 | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
-| `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                                                             |
+| `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                                                               |
-| `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                                                                |
+| `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                                        |                                                                    |
@@ -0,0 +1,13 @@
+# 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                                                                                              |
@@ -0,0 +1,17 @@
+# AssistantMessageContent
+
+
+## Supported Types
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
+### `List[components.ChatMessageContentItem]`
+
+```python
+value: List[components.ChatMessageContentItem] = /* values here */
+```
+
@@ -0,0 +1,10 @@
+# ChainID
+
+
+## Values
+
+| Name                                          | Value                                         |
+| --------------------------------------------- | --------------------------------------------- |
+| `ONE`                                         | 1                                             |
+| `ONE_HUNDRED_AND_THIRTY_SEVEN`                | 137                                           |
+| `EIGHT_THOUSAND_FOUR_HUNDRED_AND_FIFTY_THREE` | 8453                                          |
@@ -0,0 +1,12 @@
+# ChatCompletionFinishReason
+
+
+## Values
+
+| Name             | Value            |
+| ---------------- | ---------------- |
+| `TOOL_CALLS`     | tool_calls       |
+| `STOP`           | stop             |
+| `LENGTH`         | length           |
+| `CONTENT_FILTER` | content_filter   |
+| `ERROR`          | error            |
@@ -0,0 +1,11 @@
+# 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                                                |
@@ -0,0 +1,34 @@
+# 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.ChatGenerationParamsResponseFormatUnion]](../components/chatgenerationparamsresponseformatunion.md)                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
+| `seed`                                                                                                                                                                                                                                      | *OptionalNullable[int]*                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |
+| `stop`                                                                                                                                                                                                                                      | [OptionalNullable[components.ChatGenerationParamsStop]](../components/chatgenerationparamsstop.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                                                                                                                                                                                                                                         |
@@ -0,0 +1,9 @@
+# ChatGenerationParamsDataCollection
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `DENY`  | deny    |
+| `ALLOW` | allow   |
@@ -0,0 +1,9 @@
+# ChatGenerationParamsEngine
+
+
+## Values
+
+| Name     | Value    |
+| -------- | -------- |
+| `NATIVE` | native   |
+| `EXA`    | exa      |
@@ -0,0 +1,14 @@
+# 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                |
@@ -0,0 +1,8 @@
+# ChatGenerationParamsPdf
+
+
+## Fields
+
+| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `engine`                                                                                             | [Optional[components.ChatGenerationParamsPdfEngine]](../components/chatgenerationparamspdfengine.md) | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
@@ -0,0 +1,10 @@
+# ChatGenerationParamsPdfEngine
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `MISTRAL_OCR` | mistral-ocr   |
+| `PDF_TEXT`    | pdf-text      |
+| `NATIVE`      | native        |
@@ -0,0 +1,10 @@
+# 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                                              |
@@ -0,0 +1,8 @@
+# ChatGenerationParamsPluginModeration
+
+
+## Fields
+
+| Field                   | Type                    | Required                | Description             |
+| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
+| `id`                    | *Literal["moderation"]* | :heavy_check_mark:      | N/A                     |
@@ -0,0 +1,9 @@
+# ChatGenerationParamsPluginResponseHealing
+
+
+## Fields
+
+| Field                         | Type                          | Required                      | Description                   |
+| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
+| `id`                          | *Literal["response-healing"]* | :heavy_check_mark:            | N/A                           |
+| `enabled`                     | *Optional[bool]*              | :heavy_minus_sign:            | N/A                           |
@@ -0,0 +1,29 @@
+# ChatGenerationParamsPluginUnion
+
+
+## Supported Types
+
+### `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 */
+```
+
@@ -0,0 +1,12 @@
+# 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                                                    |
@@ -0,0 +1,22 @@
+# 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[float]*                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                  |
+| `preferred_max_latency`                                                                                                                                                                                                                                                              | *OptionalNullable[float]*                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                  |
+| `min_throughput`                                                                                                                                                                                                                                                                     | *OptionalNullable[float]*                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                  |
+| `max_latency`                                                                                                                                                                                                                                                                        | *OptionalNullable[float]*                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                  |
@@ -0,0 +1,8 @@
+# ChatGenerationParamsResponseFormatJSONObject
+
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `type`                   | *Literal["json_object"]* | :heavy_check_mark:       | N/A                      |
@@ -0,0 +1,8 @@
+# ChatGenerationParamsResponseFormatPython
+
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `type`              | *Literal["python"]* | :heavy_check_mark:  | N/A                 |
@@ -0,0 +1,8 @@
+# ChatGenerationParamsResponseFormatText
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *Literal["text"]*  | :heavy_check_mark: | N/A                |
@@ -0,0 +1,35 @@
+# ChatGenerationParamsResponseFormatUnion
+
+
+## Supported Types
+
+### `components.ChatGenerationParamsResponseFormatText`
+
+```python
+value: components.ChatGenerationParamsResponseFormatText = /* values here */
+```
+
+### `components.ChatGenerationParamsResponseFormatJSONObject`
+
+```python
+value: components.ChatGenerationParamsResponseFormatJSONObject = /* values here */
+```
+
+### `components.ResponseFormatJSONSchema`
+
+```python
+value: components.ResponseFormatJSONSchema = /* values here */
+```
+
+### `components.ResponseFormatTextGrammar`
+
+```python
+value: components.ResponseFormatTextGrammar = /* values here */
+```
+
+### `components.ChatGenerationParamsResponseFormatPython`
+
+```python
+value: components.ChatGenerationParamsResponseFormatPython = /* values here */
+```
+
@@ -0,0 +1,9 @@
+# ChatGenerationParamsRoute
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `FALLBACK` | fallback   |
+| `SORT`     | sort       |
@@ -1,6 +1,4 @@
-# Stop
-
-Stop sequences (up to 4)
+# ChatGenerationParamsStop


 ## Supported Types
@@ -17,9 +15,3 @@ value: str = /* values here */
 value: List[str] = /* values here */
 ```

-### `Any`
-
-```python
-value: Any = /* values here */
-```
-
@@ -0,0 +1,12 @@
+# 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                                                                                              |
@@ -0,0 +1,35 @@
+# 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 */
+```
+
@@ -0,0 +1,9 @@
+# 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                                                                                                        |
@@ -0,0 +1,9 @@
+# ChatMessageContentItemAudioInputAudio
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `data`             | *str*              | :heavy_check_mark: | N/A                |
+| `format_`          | *str*              | :heavy_check_mark: | N/A                |
@@ -0,0 +1,9 @@
+# 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                                              |
@@ -0,0 +1,9 @@
+# ChatMessageContentItemImage
+
+
+## Fields
+
+| Field                                            | Type                                             | Required                                         | Description                                      |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| `type`                                           | *Literal["image_url"]*                           | :heavy_check_mark:                               | N/A                                              |
+| `image_url`                                      | [components.ImageURL](../components/imageurl.md) | :heavy_check_mark:                               | N/A                                              |
@@ -0,0 +1,10 @@
+# ChatMessageContentItemImageDetail
+
+
+## Values
+
+| Name   | Value  |
+| ------ | ------ |
+| `AUTO` | auto   |
+| `LOW`  | low    |
+| `HIGH` | high   |
@@ -0,0 +1,10 @@
+# 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                                                                                                            |
@@ -0,0 +1,17 @@
+# ChatMessageContentItemVideo
+
+
+## Supported Types
+
+### `components.ChatMessageContentItemVideoInputVideo`
+
+```python
+value: components.ChatMessageContentItemVideoInputVideo = /* values here */
+```
+
+### `components.ChatMessageContentItemVideoVideoURL`
+
+```python
+value: components.ChatMessageContentItemVideoVideoURL = /* values here */
+```
+
@@ -0,0 +1,9 @@
+# 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                                                |
@@ -0,0 +1,9 @@
+# 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                                                |
@@ -0,0 +1,11 @@
+# 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.TopLogprob](../components/toplogprob.md)] | :heavy_check_mark:                                         | N/A                                                        |
@@ -0,0 +1,9 @@
+# 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                                                                                  |
@@ -0,0 +1,10 @@
+# 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                                                                                    |
@@ -0,0 +1,9 @@
+# ChatMessageToolCallFunction
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *str*              | :heavy_check_mark: | N/A                |
+| `arguments`        | *str*              | :heavy_check_mark: | N/A                |
@@ -0,0 +1,14 @@
+# 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                                                                                        |
@@ -0,0 +1,12 @@
+# 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                                                                                                |
+| `reasoning_details`                                                                                | List[[components.Schema3](../components/schema3.md)]                                               | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `logprobs`                                                                                         | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
@@ -0,0 +1,11 @@
+# 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                                                                                                |
@@ -0,0 +1,13 @@
+# 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.Schema3](../components/schema3.md)]                                                 | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
@@ -0,0 +1,8 @@
+# ChatStreamingMessageChunkRole
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `ASSISTANT` | assistant   |
@@ -0,0 +1,11 @@
+# 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                                                                                                                |
@@ -0,0 +1,9 @@
+# ChatStreamingMessageToolCallFunction
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *Optional[str]*    | :heavy_minus_sign: | N/A                |
+| `arguments`        | *Optional[str]*    | :heavy_minus_sign: | N/A                |
@@ -0,0 +1,8 @@
+# ChatStreamingResponseChunk
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `data`                                                                                       | [components.ChatStreamingResponseChunkData](../components/chatstreamingresponsechunkdata.md) | :heavy_check_mark:                                                                           | N/A                                                                                          |
@@ -0,0 +1,15 @@
+# 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                                                                                                      |
@@ -0,0 +1,9 @@
+# ChatStreamingResponseChunkError
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `message`          | *str*              | :heavy_check_mark: | N/A                |
+| `code`             | *float*            | :heavy_check_mark: | N/A                |
@@ -1,10 +1,8 @@
 # ChatStreamOptions

-Streaming configuration options
-

 ## Fields

-| Field                                                                                                                                                                                                  | Type                                                                                                                                                                                                   | Required                                                                                                                                                                                               | Description                                                                                                                                                                                            | Example                                                                                                                                                                                                |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| ~~`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                                                                                                                                                                                                   |
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `include_usage`    | *Optional[bool]*   | :heavy_minus_sign: | N/A                |
@@ -1,25 +1,17 @@
 # Code


-## Values
+## Supported Types
+
+### `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             |
@@ -0,0 +1,25 @@
+# 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             |
@@ -0,0 +1,13 @@
+# CompletionChoice
+
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `text`                                                                                 | *str*                                                                                  | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `index`                                                                                | *float*                                                                                | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `logprobs`                                                                             | [Nullable[components.CompletionLogprobs]](../components/completionlogprobs.md)         | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `finish_reason`                                                                        | [Nullable[components.CompletionFinishReason]](../components/completionfinishreason.md) | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `native_finish_reason`                                                                 | *Optional[str]*                                                                        | :heavy_minus_sign:                                                                     | N/A                                                                                    |
+| `reasoning`                                                                            | *OptionalNullable[str]*                                                                | :heavy_minus_sign:                                                                     | N/A                                                                                    |
@@ -0,0 +1,28 @@
+# CompletionCreateParams
+
+
+## Fields
+
+| Field                                                                                                                                | Type                                                                                                                                 | Required                                                                                                                             | Description                                                                                                                          |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `model`                                                                                                                              | *Optional[str]*                                                                                                                      | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `models`                                                                                                                             | List[*str*]                                                                                                                          | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `prompt`                                                                                                                             | [components.Prompt](../components/prompt.md)                                                                                         | :heavy_check_mark:                                                                                                                   | N/A                                                                                                                                  |
+| `best_of`                                                                                                                            | *OptionalNullable[int]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `echo`                                                                                                                               | *OptionalNullable[bool]*                                                                                                             | :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[int]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `max_tokens`                                                                                                                         | *OptionalNullable[int]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `n`                                                                                                                                  | *OptionalNullable[int]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `presence_penalty`                                                                                                                   | *OptionalNullable[float]*                                                                                                            | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `seed`                                                                                                                               | *OptionalNullable[int]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `stop`                                                                                                                               | [OptionalNullable[components.CompletionCreateParamsStop]](../components/completioncreateparamsstop.md)                               | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `stream`                                                                                                                             | *Optional[bool]*                                                                                                                     | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `stream_options`                                                                                                                     | [OptionalNullable[components.StreamOptions]](../components/streamoptions.md)                                                         | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `suffix`                                                                                                                             | *OptionalNullable[str]*                                                                                                              | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `temperature`                                                                                                                        | *OptionalNullable[float]*                                                                                                            | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `top_p`                                                                                                                              | *OptionalNullable[float]*                                                                                                            | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `user`                                                                                                                               | *Optional[str]*                                                                                                                      | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `metadata`                                                                                                                           | Dict[str, *str*]                                                                                                                     | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
+| `response_format`                                                                                                                    | [OptionalNullable[components.CompletionCreateParamsResponseFormatUnion]](../components/completioncreateparamsresponseformatunion.md) | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
@@ -0,0 +1,8 @@
+# CompletionCreateParamsResponseFormatJSONObject
+
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `type`                   | *Literal["json_object"]* | :heavy_check_mark:       | N/A                      |
@@ -0,0 +1,8 @@
+# CompletionCreateParamsResponseFormatPython
+
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `type`              | *Literal["python"]* | :heavy_check_mark:  | N/A                 |
@@ -0,0 +1,8 @@
+# CompletionCreateParamsResponseFormatText
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `type`             | *Literal["text"]*  | :heavy_check_mark: | N/A                |
@@ -0,0 +1,35 @@
+# CompletionCreateParamsResponseFormatUnion
+
+
+## Supported Types
+
+### `components.CompletionCreateParamsResponseFormatText`
+
+```python
+value: components.CompletionCreateParamsResponseFormatText = /* values here */
+```
+
+### `components.CompletionCreateParamsResponseFormatJSONObject`
+
+```python
+value: components.CompletionCreateParamsResponseFormatJSONObject = /* values here */
+```
+
+### `components.ResponseFormatJSONSchema`
+
+```python
+value: components.ResponseFormatJSONSchema = /* values here */
+```
+
+### `components.ResponseFormatTextGrammar`
+
+```python
+value: components.ResponseFormatTextGrammar = /* values here */
+```
+
+### `components.CompletionCreateParamsResponseFormatPython`
+
+```python
+value: components.CompletionCreateParamsResponseFormatPython = /* values here */
+```
+
@@ -0,0 +1,17 @@
+# CompletionCreateParamsStop
+
+
+## Supported Types
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
+### `List[str]`
+
+```python
+value: List[str] = /* values here */
+```
+
@@ -0,0 +1,10 @@
+# CompletionFinishReason
+
+
+## Values
+
+| Name             | Value            |
+| ---------------- | ---------------- |
+| `STOP`           | stop             |
+| `LENGTH`         | length           |
+| `CONTENT_FILTER` | content_filter   |
@@ -0,0 +1,11 @@
+# CompletionLogprobs
+
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `tokens`                 | List[*str*]              | :heavy_check_mark:       | N/A                      |
+| `token_logprobs`         | List[*float*]            | :heavy_check_mark:       | N/A                      |
+| `top_logprobs`           | List[Dict[str, *float*]] | :heavy_check_mark:       | N/A                      |
+| `text_offset`            | List[*float*]            | :heavy_check_mark:       | N/A                      |
@@ -0,0 +1,15 @@
+# CompletionResponse
+
+
+## Fields
+
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `id`                                                                     | *str*                                                                    | :heavy_check_mark:                                                       | N/A                                                                      |
+| `object`                                                                 | *Literal["text_completion"]*                                             | :heavy_check_mark:                                                       | N/A                                                                      |
+| `created`                                                                | *float*                                                                  | :heavy_check_mark:                                                       | N/A                                                                      |
+| `model`                                                                  | *str*                                                                    | :heavy_check_mark:                                                       | N/A                                                                      |
+| `provider`                                                               | *Optional[str]*                                                          | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `system_fingerprint`                                                     | *Optional[str]*                                                          | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `choices`                                                                | List[[components.CompletionChoice](../components/completionchoice.md)]   | :heavy_check_mark:                                                       | N/A                                                                      |
+| `usage`                                                                  | [Optional[components.CompletionUsage]](../components/completionusage.md) | :heavy_minus_sign:                                                       | N/A                                                                      |
@@ -1,13 +1,11 @@
 # CompletionTokensDetails

-Detailed completion token usage
-

 ## Fields

 | Field                        | Type                         | Required                     | Description                  |
 | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
-| `accepted_prediction_tokens` | *OptionalNullable[int]*      | :heavy_minus_sign:           | Accepted prediction tokens   |
-| `audio_tokens`               | *OptionalNullable[int]*      | :heavy_minus_sign:           | Tokens used for audio output |
-| `reasoning_tokens`           | *OptionalNullable[int]*      | :heavy_minus_sign:           | Tokens used for reasoning    |
-| `rejected_prediction_tokens` | *OptionalNullable[int]*      | :heavy_minus_sign:           | Rejected prediction tokens   |
+| `reasoning_tokens`           | *OptionalNullable[float]*    | :heavy_minus_sign:           | N/A                          |
+| `audio_tokens`               | *OptionalNullable[float]*    | :heavy_minus_sign:           | N/A                          |
+| `accepted_prediction_tokens` | *OptionalNullable[float]*    | :heavy_minus_sign:           | N/A                          |
+| `rejected_prediction_tokens` | *OptionalNullable[float]*    | :heavy_minus_sign:           | N/A                          |
@@ -0,0 +1,10 @@
+# CompletionUsage
+
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `prompt_tokens`     | *float*             | :heavy_check_mark:  | N/A                 |
+| `completion_tokens` | *float*             | :heavy_check_mark:  | N/A                 |
+| `total_tokens`      | *float*             | :heavy_check_mark:  | N/A                 |
@@ -1,12 +1,10 @@
 # CostDetails

-Breakdown of upstream inference costs
-

 ## Fields

-| Field                                 | Type                                  | Required                              | Description                           |
-| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
-| `upstream_inference_completions_cost` | *float*                               | :heavy_check_mark:                    | N/A                                   |
-| `upstream_inference_cost`             | *OptionalNullable[float]*             | :heavy_minus_sign:                    | N/A                                   |
-| `upstream_inference_prompt_cost`      | *float*                               | :heavy_check_mark:                    | N/A                                   |
+| Field                            | Type                             | Required                         | Description                      |
+| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
+| `upstream_inference_cost`        | *OptionalNullable[float]*        | :heavy_minus_sign:               | N/A                              |
+| `upstream_inference_input_cost`  | *float*                          | :heavy_check_mark:               | N/A                              |
+| `upstream_inference_output_cost` | *float*                          | :heavy_check_mark:               | N/A                              |
@@ -0,0 +1,12 @@
+# 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                                            |
@@ -0,0 +1,8 @@
+# Debug
+
+
+## Fields
+
+| Field                | Type                 | Required             | Description          |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `echo_upstream_body` | *Optional[bool]*     | :heavy_minus_sign:   | N/A                  |
@@ -7,9 +7,6 @@ Default parameters for this model

 | Field                     | Type                      | Required                  | Description               |
 | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
-| `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                       |
+| `top_p`                   | *OptionalNullable[float]* | :heavy_minus_sign:        | N/A                       |
+| `frequency_penalty`       | *OptionalNullable[float]* | :heavy_minus_sign:        | N/A                       |
@@ -0,0 +1,13 @@
+# Effort
+
+
+## Values
+
+| Name      | Value     |
+| --------- | --------- |
+| `XHIGH`   | xhigh     |
+| `HIGH`    | high      |
+| `MEDIUM`  | medium    |
+| `LOW`     | low       |
+| `MINIMAL` | minimal   |
+| `NONE`    | none      |
@@ -0,0 +1,9 @@
+# Engine
+
+
+## Values
+
+| Name     | Value    |
+| -------- | -------- |
+| `NATIVE` | native   |
+| `EXA`    | exa      |
@@ -1,11 +0,0 @@
-# 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                                                      |
 | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `type`                                                           | [components.FileCitationType](../components/filecitationtype.md) | :heavy_check_mark:                                               | N/A                                                              |
 | `file_id`                                                        | *str*                                                            | :heavy_check_mark:                                               | N/A                                                              |
 | `filename`                                                       | *str*                                                            | :heavy_check_mark:                                               | N/A                                                              |
-| `index`                                                          | *int*                                                            | :heavy_check_mark:                                               | N/A                                                              |
-| `type`                                                           | [components.FileCitationType](../components/filecitationtype.md) | :heavy_check_mark:                                               | N/A                                                              |
+| `index`                                                          | *float*                                                          | :heavy_check_mark:                                               | N/A                                                              |
@@ -5,6 +5,6 @@

 | Field                                                    | Type                                                     | Required                                                 | Description                                              |
 | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `type`                                                   | [components.FilePathType](../components/filepathtype.md) | :heavy_check_mark:                                       | N/A                                                      |
 | `file_id`                                                | *str*                                                    | :heavy_check_mark:                                       | N/A                                                      |
-| `index`                                                  | *int*                                                    | :heavy_check_mark:                                       | N/A                                                      |
-| `type`                                                   | [components.FilePathType](../components/filepathtype.md) | :heavy_check_mark:                                       | N/A                                                      |
+| `index`                                                  | *float*                                                  | :heavy_check_mark:                                       | N/A                                                      |
@@ -0,0 +1,8 @@
+# IDFileParser
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `FILE_PARSER` | file-parser   |
@@ -0,0 +1,8 @@
+# IDModeration
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `MODERATION` | moderation   |
@@ -0,0 +1,8 @@
+# IDResponseHealing
+
+
+## Values
+
+| Name               | Value              |
+| ------------------ | ------------------ |
+| `RESPONSE_HEALING` | response-healing   |
@@ -0,0 +1,8 @@
+# IDWeb
+
+
+## Values
+
+| Name  | Value |
+| ----- | ----- |
+| `WEB` | web   |
@@ -0,0 +1,17 @@
+# Ignore
+
+
+## Supported Types
+
+### `components.ProviderName`
+
+```python
+value: components.ProviderName = /* values here */
+```
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
@@ -0,0 +1,9 @@
+# ImageURL
+
+
+## Fields
+
+| Field                                                                                                        | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `url`                                                                                                        | *str*                                                                                                        | :heavy_check_mark:                                                                                           | N/A                                                                                                          |
+| `detail`                                                                                                     | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |
@@ -5,4 +5,4 @@

 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `cached_tokens`    | *int*              | :heavy_check_mark: | N/A                |
+| `cached_tokens`    | *float*            | :heavy_check_mark: | N/A                |
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Matt Apperson	0aed928ed3	fix: exclude .speakeasy/ on import to prevent gen.lock conflicts	2026-01-12 20:35:42 -05:00
Matt Apperson	66d0a82776	feat: add copybara sync workflow for monorepo integration	2026-01-12 20:10:30 -05:00