Commits included in this export:

- f35bb49a8b788937fa61c0cf4591b14f2bc8b217
  - 08a37babde9ad8df5e24e0cd865d3292b1627464
  - 7ddc8e1ed230ca489bc11a5e14696c209ea76349
  - ad31290f38f3f02627f3e1953f1d7cf3e06159a5
  - fb7f764b500618e322f56d49997fbcfaebba7e39
  - 4306c032b9b4f3cfefeacdd3d243b0336f3b2f15

GitOrigin-RevId: f35bb49a8b788937fa61c0cf4591b14f2bc8b217

.claude/settings.local.json

@@ -1,7 +1,9 @@
 {
   "permissions": {
     "allow": [
-      "Bash(python3:*)"
+      "Bash(python3:*)",
+      "Bash(git push:*)",
+      "Bash(gh pr create:*)"
     ],
     "deny": [],
     "ask": []

.speakeasy/gen.yaml

@@ -31,7 +31,7 @@ generation:
     skipResponseBodyAssertions: false
   preApplyUnionDiscriminators: true
 python:
-  version: 0.0.21
+  version: 0.7.12
   additionalDependencies:
     dev: {}
     main: {}
@@ -39,6 +39,8 @@ python:
     - id
     - object
     - input
+    - models
+    - hash
   asyncMode: both
   authors:
     - OpenRouter

.speakeasy/lint.yaml

@@ -0,0 +1,10 @@
+lintVersion: 1.0.0
+defaultRuleset: openrouter
+rulesets:
+  openrouter:
+    rulesets:
+      - speakeasy-recommended
+      - speakeasy-generation
+    rules:
+      oas3-missing-example:
+        severity: "off"

.speakeasy/overlays/add-headers.overlay.yaml

@@ -1,17 +1,18 @@
 overlay: 1.0.0
 x-speakeasy-jsonpath: rfc9535
 info:
-  title: Add HTTP-Referer and X-Title as global parameters
+  title: Add HTTP-Referer and X-OpenRouter-Title as global parameters
   version: 0.0.0
 actions:
   # Add global parameters for app identification
   - target: $
-    description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
+    description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers
     update:
       x-speakeasy-globals:
         parameters:
           - $ref: "#/components/parameters/AppIdentifier"
           - $ref: "#/components/parameters/AppDisplayName"
+          - $ref: "#/components/parameters/AppCategories"
 
   # Add component parameters
   - target: $.components
@@ -27,9 +28,25 @@ actions:
             The app identifier should be your app's URL and is used as the primary identifier for rankings.
             This is used to track API usage per application.
         AppDisplayName:
-          name: X-Title
+          name: X-OpenRouter-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"

.speakeasy/workflow.lock

@@ -2,23 +2,26 @@ speakeasyVersion: 1.666.0
 sources:
     -OAS:
         sourceNamespace: open-router-chat-completions-api
-        sourceRevisionDigest: sha256:f1b59b9b643de5e20d6e3299a8274783d8c0854615876f5d7f6f081814842695
+        sourceRevisionDigest: sha256:01256c8494de6bfc13c36d82ae316a6a13d402194f844618bcd4d59e34f325f3
-        sourceBlobDigest: sha256:ee1f2422281b3ed5b38951c74636ad192c9bb160f216069c1f7931ccc4e52553
+        sourceBlobDigest: sha256:4c80e48fd5e1cd030e68d664eb93984b4d5946867252ff1755a2bd2a05eccd4e
         tags:
             - latest
     OpenRouter API:
         sourceNamespace: open-router-chat-completions-api
-        sourceRevisionDigest: sha256:9b410c8cfafe475dc6d9550f97a1e755b9a02b54513d3a85efe606e9bb05ca57
+        sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707
-        sourceBlobDigest: sha256:61a2d897cc5ddd893a5131bfacad7fcc311fe5b2eaaa5641fbb0a5b3321bfde7
+        sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e
         tags:
             - latest
+            - main
             - 1.0.0
 targets:
     open-router:
         source: OpenRouter API
         sourceNamespace: open-router-chat-completions-api
-        sourceRevisionDigest: sha256:9b410c8cfafe475dc6d9550f97a1e755b9a02b54513d3a85efe606e9bb05ca57
+        sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707
-        sourceBlobDigest: sha256:61a2d897cc5ddd893a5131bfacad7fcc311fe5b2eaaa5641fbb0a5b3321bfde7
+        sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e
+        codeSamplesNamespace: open-router-python-code-samples
+        codeSamplesRevisionDigest: sha256:44bca5099ff33e05a3f4e5acf8f83f48dc1d84efc8758381a528abcc871bc874
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: 1.666.0
@@ -42,7 +45,7 @@ workflow:
                     token: $pypi_token
             codeSamples:
                 registry:
-                    location: registry.speakeasyapi.dev/openrouter/sdk/-oas-python-code-samples
+                    location: registry.speakeasyapi.dev/openrouter/sdk/open-router-python-code-samples
                 labelOverride:
                     fixedValue: Python (SDK)
                 blocking: false

README-PYPI.md

@@ -182,6 +182,9 @@ 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...
@@ -191,6 +194,9 @@ 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...

README.md

@@ -182,6 +182,9 @@ 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...
@@ -191,6 +194,9 @@ 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...

USAGE.md

@@ -6,6 +6,9 @@ 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:
 
@@ -30,6 +33,9 @@ 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:
 

docs/components/action.md

@@ -0,0 +1,23 @@
+# Action
+
+
+## Supported Types
+
+### `components.ActionSearch`
+
+```python
+value: components.ActionSearch = /* values here */
+```
+
+### `components.ActionOpenPage`
+
+```python
+value: components.ActionOpenPage = /* values here */
+```
+
+### `components.ActionFindInPage`
+
+```python
+value: components.ActionFindInPage = /* values here */
+```
+

docs/components/actionfindinpage.md

@@ -1,10 +1,10 @@
-# MessageDeveloper
+# ActionFindInPage
 
 
 ## Fields
 
 | Field                                                        | Type                                                         | Required                                                     | Description                                                  |
 | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `role`                                                       | *Literal["developer"]*                                       | :heavy_check_mark:                                           | N/A                                                          |
+| `type`                                                       | [components.TypeFindInPage](../components/typefindinpage.md) | :heavy_check_mark:                                           | N/A                                                          |
-| `content`                                                    | [components.MessageContent](../components/messagecontent.md) | :heavy_check_mark:                                           | N/A                                                          |
+| `pattern`                                                    | *str*                                                        | :heavy_check_mark:                                           | N/A                                                          |
-| `name`                                                       | *Optional[str]*                                              | :heavy_minus_sign:                                           | N/A                                                          |
+| `url`                                                        | *str*                                                        | :heavy_check_mark:                                           | N/A                                                          |

docs/components/actionopenpage.md

@@ -1,8 +1,9 @@
-# PluginModeration
+# ActionOpenPage
 
 
 ## Fields
 
 | Field                                                    | Type                                                     | Required                                                 | Description                                              |
 | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
-| `id`                                                     | [components.IDModeration](../components/idmoderation.md) | :heavy_check_mark:                                       | N/A                                                      |
+| `type`                                                   | [components.TypeOpenPage](../components/typeopenpage.md) | :heavy_check_mark:                                       | N/A                                                      |
+| `url`                                                    | *OptionalNullable[str]*                                  | :heavy_minus_sign:                                       | N/A                                                      |

docs/components/actionsearch.md

@@ -0,0 +1,11 @@
+# ActionSearch
+
+
+## Fields
+
+| Field                                                | Type                                                 | Required                                             | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
+| `type`                                               | [components.TypeSearch](../components/typesearch.md) | :heavy_check_mark:                                   | N/A                                                  |
+| `query`                                              | *str*                                                | :heavy_check_mark:                                   | N/A                                                  |
+| `queries`                                            | List[*str*]                                          | :heavy_minus_sign:                                   | N/A                                                  |
+| `sources`                                            | List[[components.Source](../components/source.md)]   | :heavy_minus_sign:                                   | N/A                                                  |

docs/components/allowedtools.md

@@ -1,9 +1,9 @@
-# ChatStreamingResponseChunkError
+# AllowedTools
 
 
 ## Fields
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `message`          | *str*              | :heavy_check_mark: | N/A                |
+| `tool_names`       | List[*str*]        | :heavy_minus_sign: | N/A                |
-| `code`             | *float*            | :heavy_check_mark: | N/A                |
+| `read_only`        | *Optional[bool]*   | :heavy_minus_sign: | N/A                |

docs/components/always.md

@@ -1,8 +1,8 @@
-# VideoURL2
+# Always
 
 
 ## Fields
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `url`              | *str*              | :heavy_check_mark: | N/A                |
+| `tool_names`       | List[*str*]        | :heavy_minus_sign: | N/A                |

docs/components/assistantmessage.md

@@ -1,13 +1,18 @@
 # AssistantMessage
 
+Assistant message for requests and responses
+
 
 ## Fields
 
-| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| Field                                                                                                                                                                                | Type                                                                                                                                                                                 | Required                                                                                                                                                                             | Description                                                                                                                                                                          | Example                                                                                                                                                                              |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `role`                                                                                           | *Literal["assistant"]*                                                                           | :heavy_check_mark:                                                                               | N/A                                                                                              |
+| `role`                                                                                                                                                                               | [components.AssistantMessageRole](../components/assistantmessagerole.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                                   | N/A                                                                                                                                                                                  |                                                                                                                                                                                      |
-| `content`                                                                                        | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `content`                                                                                                                                                                            | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md)                                                                                     | :heavy_minus_sign:                                                                                                                                                                   | Assistant message content                                                                                                                                                            |                                                                                                                                                                                      |
-| `name`                                                                                           | *Optional[str]*                                                                                  | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `name`                                                                                                                                                                               | *Optional[str]*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                   | Optional name for the assistant                                                                                                                                                      |                                                                                                                                                                                      |
-| `tool_calls`                                                                                     | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)]                     | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `tool_calls`                                                                                                                                                                         | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)]                                                                                                         | :heavy_minus_sign:                                                                                                                                                                   | Tool calls made by the assistant                                                                                                                                                     |                                                                                                                                                                                      |
-| `refusal`                                                                                        | *OptionalNullable[str]*                                                                          | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `refusal`                                                                                                                                                                            | *OptionalNullable[str]*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Refusal message if content was refused                                                                                                                                               |                                                                                                                                                                                      |
-| `reasoning`                                                                                      | *OptionalNullable[str]*                                                                          | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `reasoning`                                                                                                                                                                          | *OptionalNullable[str]*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Reasoning output                                                                                                                                                                     |                                                                                                                                                                                      |
+| `reasoning_details`                                                                                                                                                                  | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)]                                                                                                       | :heavy_minus_sign:                                                                                                                                                                   | Reasoning details for extended thinking models                                                                                                                                       |                                                                                                                                                                                      |
+| `images`                                                                                                                                                                             | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)]                                                                                                   | :heavy_minus_sign:                                                                                                                                                                   | Generated images from image generation models                                                                                                                                        | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>]                                                                                       |
+| `audio`                                                                                                                                                                              | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md)                                                                                         | :heavy_minus_sign:                                                                                                                                                                   | Audio output data or reference                                                                                                                                                       | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |

docs/components/assistantmessagecontent.md

@@ -1,5 +1,7 @@
 # AssistantMessageContent
 
+Assistant message content
+
 
 ## Supported Types
 
@@ -15,3 +17,9 @@ value: str = /* values here */
 value: List[components.ChatMessageContentItem] = /* values here */
 ```
 
+### `Any`
+
+```python
+value: Any = /* values here */
+```
+

docs/components/assistantmessageimages.md

@@ -0,0 +1,8 @@
+# AssistantMessageImages
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `image_url`                                                                                  | [components.AssistantMessageImagesImageURL](../components/assistantmessageimagesimageurl.md) | :heavy_check_mark:                                                                           | N/A                                                                                          |

docs/components/assistantmessageimagesimageurl.md

@@ -0,0 +1,8 @@
+# AssistantMessageImagesImageURL
+
+
+## Fields
+
+| Field                                             | Type                                              | Required                                          | Description                                       |
+| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
+| `url`                                             | *str*                                             | :heavy_check_mark:                                | URL or base64-encoded data of the generated image |

docs/components/assistantmessagerole.md

@@ -0,0 +1,8 @@
+# AssistantMessageRole
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `ASSISTANT` | assistant   |

docs/components/background.md

@@ -0,0 +1,10 @@
+# Background
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `TRANSPARENT` | transparent   |
+| `OPAQUE`      | opaque        |
+| `AUTO`        | auto          |

docs/components/by.md

@@ -0,0 +1,13 @@
+# By
+
+The provider sorting strategy (price, throughput, latency)
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `PRICE`      | price        |
+| `THROUGHPUT` | throughput   |
+| `LATENCY`    | latency      |
+| `EXACTO`     | exacto       |

docs/components/cachecontrol.md

@@ -0,0 +1,11 @@
+# CacheControl
+
+Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.
+
+
+## Fields
+
+| Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `type`                                                                                   | [components.ChatGenerationParamsType](../components/chatgenerationparamstype.md)         | :heavy_check_mark:                                                                       | N/A                                                                                      |
+| `ttl`                                                                                    | [Optional[components.ChatGenerationParamsTTL]](../components/chatgenerationparamsttl.md) | :heavy_minus_sign:                                                                       | N/A                                                                                      |

docs/components/chatcompletionaudiooutput.md

@@ -0,0 +1,13 @@
+# ChatCompletionAudioOutput
+
+Audio output data or reference
+
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `id`                       | *Optional[str]*            | :heavy_minus_sign:         | Audio output identifier    |
+| `expires_at`               | *Optional[float]*          | :heavy_minus_sign:         | Audio expiration timestamp |
+| `data`                     | *Optional[str]*            | :heavy_minus_sign:         | Base64 encoded audio data  |
+| `transcript`               | *Optional[str]*            | :heavy_minus_sign:         | Audio transcript           |

docs/components/chaterrorerror.md

@@ -1,11 +0,0 @@
-# ChatErrorError
-
-
-## Fields
-
-| Field                                              | Type                                               | Required                                           | Description                                        |
-| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
-| `code`                                             | [Nullable[components.Code]](../components/code.md) | :heavy_check_mark:                                 | N/A                                                |
-| `message`                                          | *str*                                              | :heavy_check_mark:                                 | N/A                                                |
-| `param`                                            | *OptionalNullable[str]*                            | :heavy_minus_sign:                                 | N/A                                                |
-| `type`                                             | *OptionalNullable[str]*                            | :heavy_minus_sign:                                 | N/A                                                |

docs/components/chatgenerationparams.md

@@ -1,30 +1,40 @@
 # ChatGenerationParams
 
+Chat completion request parameters
+
 
 ## Fields
 
-| Field                                                                                                                    | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              |
+| Field                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                 | Example                                                                                                                                                                                                                                     |
-| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `messages`                                                                                                               | List[[components.Message](../components/message.md)]                                                                     | :heavy_check_mark:                                                                                                       | N/A                                                                                                                      |
+| `provider`                                                                                                                                                                                                                                  | [OptionalNullable[components.ChatGenerationParamsProvider]](../components/chatgenerationparamsprovider.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | When multiple model providers are available, optionally indicate your routing preference.                                                                                                                                                   |                                                                                                                                                                                                                                             |
-| `model`                                                                                                                  | *Optional[str]*                                                                                                          | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `plugins`                                                                                                                                                                                                                                   | List[[components.ChatGenerationParamsPluginUnion](../components/chatgenerationparamspluginunion.md)]                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                          | Plugins you want to enable for this request, including their settings.                                                                                                                                                                      |                                                                                                                                                                                                                                             |
-| `models`                                                                                                                 | List[*str*]                                                                                                              | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `user`                                                                                                                                                                                                                                      | *Optional[str]*                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                          | Unique user identifier                                                                                                                                                                                                                      | user-123                                                                                                                                                                                                                                    |
-| `frequency_penalty`                                                                                                      | *OptionalNullable[float]*                                                                                                | :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. |                                                                                                                                                                                                                                             |
-| `logit_bias`                                                                                                             | Dict[str, *float*]                                                                                                       | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `trace`                                                                                                                                                                                                                                     | [Optional[components.ChatGenerationParamsTrace]](../components/chatgenerationparamstrace.md)                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                          | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.    |                                                                                                                                                                                                                                             |
-| `logprobs`                                                                                                               | *OptionalNullable[bool]*                                                                                                 | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `messages`                                                                                                                                                                                                                                  | List[[components.Message](../components/message.md)]                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                          | List of messages for the conversation                                                                                                                                                                                                       | [<br/>{<br/>"role": "user",<br/>"content": "Hello!"<br/>}<br/>]                                                                                                                                                                             |
-| `top_logprobs`                                                                                                           | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `model`                                                                                                                                                                                                                                     | *Optional[str]*                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                          | Model to use for completion                                                                                                                                                                                                                 | openai/gpt-4                                                                                                                                                                                                                                |
-| `max_completion_tokens`                                                                                                  | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `models`                                                                                                                                                                                                                                    | List[*str*]                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                          | Models to use for completion                                                                                                                                                                                                                | [<br/>"openai/gpt-4",<br/>"openai/gpt-4o"<br/>]                                                                                                                                                                                             |
-| `max_tokens`                                                                                                             | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `frequency_penalty`                                                                                                                                                                                                                         | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Frequency penalty (-2.0 to 2.0)                                                                                                                                                                                                             | 0                                                                                                                                                                                                                                           |
-| `metadata`                                                                                                               | Dict[str, *str*]                                                                                                         | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `logit_bias`                                                                                                                                                                                                                                | Dict[str, *float*]                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                          | Token logit bias adjustments                                                                                                                                                                                                                | {<br/>"50256": -100<br/>}                                                                                                                                                                                                                   |
-| `presence_penalty`                                                                                                       | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `logprobs`                                                                                                                                                                                                                                  | *OptionalNullable[bool]*                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | Return log probabilities                                                                                                                                                                                                                    | false                                                                                                                                                                                                                                       |
-| `reasoning`                                                                                                              | [Optional[components.Reasoning]](../components/reasoning.md)                                                             | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `top_logprobs`                                                                                                                                                                                                                              | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Number of top log probabilities to return (0-20)                                                                                                                                                                                            | 5                                                                                                                                                                                                                                           |
-| `response_format`                                                                                                        | [Optional[components.ChatGenerationParamsResponseFormatUnion]](../components/chatgenerationparamsresponseformatunion.md) | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `max_completion_tokens`                                                                                                                                                                                                                     | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Maximum tokens in completion                                                                                                                                                                                                                | 100                                                                                                                                                                                                                                         |
-| `seed`                                                                                                                   | *OptionalNullable[int]*                                                                                                  | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `max_tokens`                                                                                                                                                                                                                                | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16.                                                                                                                                       | 100                                                                                                                                                                                                                                         |
-| `stop`                                                                                                                   | [OptionalNullable[components.ChatGenerationParamsStop]](../components/chatgenerationparamsstop.md)                       | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `metadata`                                                                                                                                                                                                                                  | Dict[str, *str*]                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                          | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values)                                                                                                                                             | {<br/>"user_id": "user-123",<br/>"session_id": "session-456"<br/>}                                                                                                                                                                          |
-| `stream`                                                                                                                 | *Optional[bool]*                                                                                                         | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `presence_penalty`                                                                                                                                                                                                                          | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Presence penalty (-2.0 to 2.0)                                                                                                                                                                                                              | 0                                                                                                                                                                                                                                           |
-| `stream_options`                                                                                                         | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md)                                     | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `reasoning`                                                                                                                                                                                                                                 | [Optional[components.Reasoning]](../components/reasoning.md)                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                          | Configuration options for reasoning models                                                                                                                                                                                                  | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>}                                                                                                                                                                                    |
-| `temperature`                                                                                                            | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `response_format`                                                                                                                                                                                                                           | [Optional[components.ResponseFormat]](../components/responseformat.md)                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                          | Response format configuration                                                                                                                                                                                                               | {<br/>"type": "json_object"<br/>}                                                                                                                                                                                                           |
-| `tool_choice`                                                                                                            | *Optional[Any]*                                                                                                          | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `seed`                                                                                                                                                                                                                                      | *OptionalNullable[int]*                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                          | Random seed for deterministic outputs                                                                                                                                                                                                       | 42                                                                                                                                                                                                                                          |
-| `tools`                                                                                                                  | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)]                                               | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `stop`                                                                                                                                                                                                                                      | [OptionalNullable[components.Stop]](../components/stop.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | Stop sequences (up to 4)                                                                                                                                                                                                                    | [<br/>""<br/>]                                                                                                                                                                                                                              |
-| `top_p`                                                                                                                  | *OptionalNullable[float]*                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `stream`                                                                                                                                                                                                                                    | *Optional[bool]*                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                          | Enable streaming response                                                                                                                                                                                                                   | false                                                                                                                                                                                                                                       |
-| `user`                                                                                                                   | *Optional[str]*                                                                                                          | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `stream_options`                                                                                                                                                                                                                            | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md)                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                          | Streaming configuration options                                                                                                                                                                                                             | {<br/>"include_usage": true<br/>}                                                                                                                                                                                                           |
-| `debug`                                                                                                                  | [Optional[components.Debug]](../components/debug.md)                                                                     | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `temperature`                                                                                                                                                                                                                               | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Sampling temperature (0-2)                                                                                                                                                                                                                  | 0.7                                                                                                                                                                                                                                         |
+| `parallel_tool_calls`                                                                                                                                                                                                                       | *OptionalNullable[bool]*                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `tool_choice`                                                                                                                                                                                                                               | [Optional[components.ToolChoiceOption]](../components/toolchoiceoption.md)                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | Tool choice configuration                                                                                                                                                                                                                   | auto                                                                                                                                                                                                                                        |
+| `tools`                                                                                                                                                                                                                                     | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)]                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                          | Available tools for function calling                                                                                                                                                                                                        | [<br/>{<br/>"type": "function",<br/>"function": {<br/>"name": "get_weather",<br/>"description": "Get weather"<br/>}<br/>}<br/>]                                                                                                             |
+| `top_p`                                                                                                                                                                                                                                     | *OptionalNullable[float]*                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Nucleus sampling parameter (0-1)                                                                                                                                                                                                            | 1                                                                                                                                                                                                                                           |
+| `debug`                                                                                                                                                                                                                                     | [Optional[components.DebugOptions]](../components/debugoptions.md)                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                          | Debug options for inspecting request transformations (streaming only)                                                                                                                                                                       | {<br/>"echo_upstream_body": true<br/>}                                                                                                                                                                                                      |
+| `image_config`                                                                                                                                                                                                                              | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)]                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                          | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details.                                                         | {<br/>"aspect_ratio": "16:9"<br/>}                                                                                                                                                                                                          |
+| `modalities`                                                                                                                                                                                                                                | List[[components.Modality](../components/modality.md)]                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                          | Output modalities for the response. Supported values are "text", "image", and "audio".                                                                                                                                                      | [<br/>"text",<br/>"image"<br/>]                                                                                                                                                                                                             |
+| `cache_control`                                                                                                                                                                                                                             | [Optional[components.CacheControl]](../components/cachecontrol.md)                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                          | Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.                                                  |                                                                                                                                                                                                                                             |

docs/components/chatgenerationparamsby.md

@@ -0,0 +1,13 @@
+# ChatGenerationParamsBy
+
+The provider sorting strategy (price, throughput, latency)
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `PRICE`      | price        |
+| `THROUGHPUT` | throughput   |
+| `LATENCY`    | latency      |
+| `EXACTO`     | exacto       |

docs/components/chatgenerationparamsengine.md

@@ -1,4 +1,4 @@
-# Engine
+# ChatGenerationParamsEngine
 
 
 ## Values

docs/components/chatgenerationparamsidautorouter.md

@@ -0,0 +1,8 @@
+# ChatGenerationParamsIDAutoRouter
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `AUTO_ROUTER` | auto-router   |

docs/components/chatgenerationparamsidfileparser.md

@@ -1,4 +1,4 @@
-# IDFileParser
+# ChatGenerationParamsIDFileParser
 
 
 ## Values

docs/components/chatgenerationparamsidmoderation.md

@@ -1,4 +1,4 @@
-# IDModeration
+# ChatGenerationParamsIDModeration
 
 
 ## Values

docs/components/chatgenerationparamsidresponsehealing.md

@@ -1,4 +1,4 @@
-# IDResponseHealing
+# ChatGenerationParamsIDResponseHealing
 
 
 ## Values

docs/components/chatgenerationparamsidweb.md

@@ -1,4 +1,4 @@
-# IDWeb
+# ChatGenerationParamsIDWeb
 
 
 ## Values

docs/components/chatgenerationparamsignore.md

@@ -0,0 +1,17 @@
+# ChatGenerationParamsIgnore
+
+
+## Supported Types
+
+### `components.ProviderName`
+
+```python
+value: components.ProviderName = /* values here */
+```
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+

docs/components/chatgenerationparamsimageconfig.md

@@ -0,0 +1,23 @@
+# ChatGenerationParamsImageConfig
+
+
+## Supported Types
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
+### `float`
+
+```python
+value: float = /* values here */
+```
+
+### `List[Nullable[Any]]`
+
+```python
+value: List[Nullable[Any]] = /* values here */
+```
+

docs/components/chatgenerationparamsmaxprice.md

@@ -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                     | Example                         |
+| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
+| `prompt`                        | *Optional[str]*                 | :heavy_minus_sign:              | Price per million prompt tokens | 1000                            |
+| `completion`                    | *Optional[str]*                 | :heavy_minus_sign:              | N/A                             | 1000                            |
+| `image`                         | *Optional[str]*                 | :heavy_minus_sign:              | N/A                             | 1000                            |
+| `audio`                         | *Optional[str]*                 | :heavy_minus_sign:              | N/A                             | 1000                            |
+| `request`                       | *Optional[str]*                 | :heavy_minus_sign:              | N/A                             | 1000                            |

docs/components/chatgenerationparamsonly.md

@@ -0,0 +1,17 @@
+# ChatGenerationParamsOnly
+
+
+## Supported Types
+
+### `components.ProviderName`
+
+```python
+value: components.ProviderName = /* values here */
+```
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+

docs/components/chatgenerationparamsorder.md

@@ -0,0 +1,17 @@
+# ChatGenerationParamsOrder
+
+
+## Supported Types
+
+### `components.ProviderName`
+
+```python
+value: components.ProviderName = /* values here */
+```
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+

docs/components/chatgenerationparamspartition.md

@@ -0,0 +1,11 @@
+# ChatGenerationParamsPartition
+
+Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model.
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `MODEL` | model   |
+| `NONE`  | none    |

docs/components/chatgenerationparamspdf.md

@@ -0,0 +1,8 @@
+# ChatGenerationParamsPdf
+
+
+## Fields
+
+| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `engine`                                                                                             | [Optional[components.ChatGenerationParamsPdfEngine]](../components/chatgenerationparamspdfengine.md) | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |

docs/components/chatgenerationparamspdfengine.md

@@ -1,4 +1,4 @@
-# PdfEngine
+# ChatGenerationParamsPdfEngine
 
 
 ## Values

docs/components/chatgenerationparamspluginautorouter.md

@@ -0,0 +1,10 @@
+# ChatGenerationParamsPluginAutoRouter
+
+
+## Fields
+
+| Field                                                                                                                                                                                                               | Type                                                                                                                                                                                                                | Required                                                                                                                                                                                                            | Description                                                                                                                                                                                                         | Example                                                                                                                                                                                                             |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                                                                                                                | [components.ChatGenerationParamsIDAutoRouter](../components/chatgenerationparamsidautorouter.md)                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                 |                                                                                                                                                                                                                     |
+| `enabled`                                                                                                                                                                                                           | *Optional[bool]*                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                  | Set to false to disable the auto-router plugin for this request. Defaults to true.                                                                                                                                  |                                                                                                                                                                                                                     |
+| `allowed_models`                                                                                                                                                                                                    | List[*str*]                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                  | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list. | [<br/>"anthropic/*",<br/>"openai/gpt-4o",<br/>"google/*"<br/>]                                                                                                                                                      |

docs/components/chatgenerationparamspluginfileparser.md

@@ -0,0 +1,10 @@
+# ChatGenerationParamsPluginFileParser
+
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `id`                                                                                             | [components.ChatGenerationParamsIDFileParser](../components/chatgenerationparamsidfileparser.md) | :heavy_check_mark:                                                                               | N/A                                                                                              |
+| `enabled`                                                                                        | *Optional[bool]*                                                                                 | :heavy_minus_sign:                                                                               | Set to false to disable the file-parser plugin for this request. Defaults to true.               |
+| `pdf`                                                                                            | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.md)                       | :heavy_minus_sign:                                                                               | Options for PDF parsing.                                                                         |

docs/components/chatgenerationparamspluginmoderation.md

@@ -0,0 +1,8 @@
+# ChatGenerationParamsPluginModeration
+
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `id`                                                                                             | [components.ChatGenerationParamsIDModeration](../components/chatgenerationparamsidmoderation.md) | :heavy_check_mark:                                                                               | N/A                                                                                              |

docs/components/chatgenerationparamspluginresponsehealing.md

@@ -0,0 +1,9 @@
+# ChatGenerationParamsPluginResponseHealing
+
+
+## Fields
+
+| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                       | [components.ChatGenerationParamsIDResponseHealing](../components/chatgenerationparamsidresponsehealing.md) | :heavy_check_mark:                                                                                         | N/A                                                                                                        |
+| `enabled`                                                                                                  | *Optional[bool]*                                                                                           | :heavy_minus_sign:                                                                                         | Set to false to disable the response-healing plugin for this request. Defaults to true.                    |

docs/components/chatgenerationparamspluginunion.md

@@ -0,0 +1,35 @@
+# ChatGenerationParamsPluginUnion
+
+
+## Supported Types
+
+### `components.ChatGenerationParamsPluginAutoRouter`
+
+```python
+value: components.ChatGenerationParamsPluginAutoRouter = /* values here */
+```
+
+### `components.ChatGenerationParamsPluginModeration`
+
+```python
+value: components.ChatGenerationParamsPluginModeration = /* values here */
+```
+
+### `components.ChatGenerationParamsPluginWeb`
+
+```python
+value: components.ChatGenerationParamsPluginWeb = /* values here */
+```
+
+### `components.ChatGenerationParamsPluginFileParser`
+
+```python
+value: components.ChatGenerationParamsPluginFileParser = /* values here */
+```
+
+### `components.ChatGenerationParamsPluginResponseHealing`
+
+```python
+value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
+```
+

docs/components/chatgenerationparamspluginweb.md

@@ -0,0 +1,14 @@
+# ChatGenerationParamsPluginWeb
+
+
+## Fields
+
+| Field                                                                                                                                         | Type                                                                                                                                          | Required                                                                                                                                      | Description                                                                                                                                   | Example                                                                                                                                       |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                                          | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md)                                                            | :heavy_check_mark:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
+| `enabled`                                                                                                                                     | *Optional[bool]*                                                                                                                              | :heavy_minus_sign:                                                                                                                            | Set to false to disable the web-search plugin for this request. Defaults to true.                                                             |                                                                                                                                               |
+| `max_results`                                                                                                                                 | *Optional[float]*                                                                                                                             | :heavy_minus_sign:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
+| `search_prompt`                                                                                                                               | *Optional[str]*                                                                                                                               | :heavy_minus_sign:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
+| `engine`                                                                                                                                      | [Optional[components.WebSearchEngine]](../components/websearchengine.md)                                                                      | :heavy_minus_sign:                                                                                                                            | The search engine to use for web search.                                                                                                      |                                                                                                                                               |
+| `include_domains`                                                                                                                             | List[*str*]                                                                                                                                   | :heavy_minus_sign:                                                                                                                            | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").  | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                        |
+| `exclude_domains`                                                                                                                             | List[*str*]                                                                                                                                   | :heavy_minus_sign:                                                                                                                            | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                        |

docs/components/chatgenerationparamsprovider.md

@@ -0,0 +1,22 @@
+# ChatGenerationParamsProvider
+
+When multiple model providers are available, optionally indicate your routing preference.
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                               | Example                                                                                                                                                                                                                                                                                                                                                   |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `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.DataCollection]](../components/datacollection.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.                                                                    | allow                                                                                                                                                                                                                                                                                                                                                     |
+| `zdr`                                                                                                                                                                                                                                                                                                                                                     | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used.                                                                                                                                                                                                               | true                                                                                                                                                                                                                                                                                                                                                      |
+| `enforce_distillable_text`                                                                                                                                                                                                                                                                                                                                | *OptionalNullable[bool]*                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used.                                                                                                                                                                                                   | true                                                                                                                                                                                                                                                                                                                                                      |
+| `order`                                                                                                                                                                                                                                                                                                                                                   | List[[components.ChatGenerationParamsOrder](../components/chatgenerationparamsorder.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.ChatGenerationParamsOnly](../components/chatgenerationparamsonly.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.ChatGenerationParamsIgnore](../components/chatgenerationparamsignore.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.Quantization](../components/quantization.md)]                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | A list of quantization levels to filter the provider by.                                                                                                                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                                                                                                           |
+| `sort`                                                                                                                                                                                                                                                                                                                                                    | [OptionalNullable[components.ChatGenerationParamsSortUnion]](../components/chatgenerationparamssortunion.md)                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                       | price                                                                                                                                                                                                                                                                                                                                                     |
+| `max_price`                                                                                                                                                                                                                                                                                                                                               | [Optional[components.ChatGenerationParamsMaxPrice]](../components/chatgenerationparamsmaxprice.md)                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                           |
+| `preferred_min_throughput`                                                                                                                                                                                                                                                                                                                                | [OptionalNullable[components.PreferredMinThroughput]](../components/preferredminthroughput.md)                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100                                                                                                                                                                                                                                                                                                                                                       |
+| `preferred_max_latency`                                                                                                                                                                                                                                                                                                                                   | [OptionalNullable[components.PreferredMaxLatency]](../components/preferredmaxlatency.md)                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold.              | 5                                                                                                                                                                                                                                                                                                                                                         |

docs/components/chatgenerationparamsprovidersort.md

@@ -0,0 +1,13 @@
+# ChatGenerationParamsProviderSort
+
+The provider sorting strategy (price, throughput, latency)
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `PRICE`      | price        |
+| `THROUGHPUT` | throughput   |
+| `LATENCY`    | latency      |
+| `EXACTO`     | exacto       |

docs/components/chatgenerationparamsprovidersortconfig.md

@@ -0,0 +1,9 @@
+# ChatGenerationParamsProviderSortConfig
+
+
+## Fields
+
+| Field                                                                                                                                                                                      | Type                                                                                                                                                                                       | Required                                                                                                                                                                                   | Description                                                                                                                                                                                | Example                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `by`                                                                                                                                                                                       | [OptionalNullable[components.ChatGenerationParamsBy]](../components/chatgenerationparamsby.md)                                                                                             | :heavy_minus_sign:                                                                                                                                                                         | The provider sorting strategy (price, throughput, latency)                                                                                                                                 | price                                                                                                                                                                                      |
+| `partition`                                                                                                                                                                                | [OptionalNullable[components.ChatGenerationParamsPartition]](../components/chatgenerationparamspartition.md)                                                                               | :heavy_minus_sign:                                                                                                                                                                         | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model                                                                                                                                                                                      |

docs/components/chatgenerationparamsprovidersortconfigenum.md

@@ -0,0 +1,11 @@
+# ChatGenerationParamsProviderSortConfigEnum
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `PRICE`      | price        |
+| `THROUGHPUT` | throughput   |
+| `LATENCY`    | latency      |
+| `EXACTO`     | exacto       |

docs/components/chatgenerationparamsprovidersortconfigunion.md

@@ -0,0 +1,17 @@
+# ChatGenerationParamsProviderSortConfigUnion
+
+
+## Supported Types
+
+### `components.ChatGenerationParamsProviderSortConfig`
+
+```python
+value: components.ChatGenerationParamsProviderSortConfig = /* values here */
+```
+
+### `components.ChatGenerationParamsProviderSortConfigEnum`
+
+```python
+value: components.ChatGenerationParamsProviderSortConfigEnum = /* values here */
+```
+

docs/components/chatgenerationparamsresponseformatjsonobject.md

@@ -1,8 +0,0 @@
-# ChatGenerationParamsResponseFormatJSONObject
-
-
-## Fields
-
-| Field                    | Type                     | Required                 | Description              |
-| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
-| `type`                   | *Literal["json_object"]* | :heavy_check_mark:       | N/A                      |

docs/components/chatgenerationparamsresponseformatpython.md

@@ -1,8 +0,0 @@
-# ChatGenerationParamsResponseFormatPython
-
-
-## Fields
-
-| Field               | Type                | Required            | Description         |
-| ------------------- | ------------------- | ------------------- | ------------------- |
-| `type`              | *Literal["python"]* | :heavy_check_mark:  | N/A                 |

docs/components/chatgenerationparamsresponseformattext.md

@@ -1,8 +0,0 @@
-# ChatGenerationParamsResponseFormatText
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `type`             | *Literal["text"]*  | :heavy_check_mark: | N/A                |

docs/components/chatgenerationparamsresponseformatunion.md

@@ -1,35 +0,0 @@
-# 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 */
-```
-

docs/components/chatgenerationparamsroute.md

@@ -0,0 +1,9 @@
+# ChatGenerationParamsRoute
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `FALLBACK` | fallback   |
+| `SORT`     | sort       |

docs/components/chatgenerationparamssortenum.md

@@ -0,0 +1,11 @@
+# ChatGenerationParamsSortEnum
+
+
+## Values
+
+| Name         | Value        |
+| ------------ | ------------ |
+| `PRICE`      | price        |
+| `THROUGHPUT` | throughput   |
+| `LATENCY`    | latency      |
+| `EXACTO`     | exacto       |

docs/components/chatgenerationparamssortunion.md

@@ -0,0 +1,25 @@
+# ChatGenerationParamsSortUnion
+
+The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
+
+
+## Supported Types
+
+### `components.ChatGenerationParamsProviderSort`
+
+```python
+value: components.ChatGenerationParamsProviderSort = /* values here */
+```
+
+### `components.ChatGenerationParamsProviderSortConfigUnion`
+
+```python
+value: components.ChatGenerationParamsProviderSortConfigUnion = /* values here */
+```
+
+### `components.ChatGenerationParamsSortEnum`
+
+```python
+value: components.ChatGenerationParamsSortEnum = /* values here */
+```
+

docs/components/chatgenerationparamstrace.md

@@ -0,0 +1,15 @@
+# ChatGenerationParamsTrace
+
+Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
+
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `trace_id`                 | *Optional[str]*            | :heavy_minus_sign:         | N/A                        |
+| `trace_name`               | *Optional[str]*            | :heavy_minus_sign:         | N/A                        |
+| `span_name`                | *Optional[str]*            | :heavy_minus_sign:         | N/A                        |
+| `generation_name`          | *Optional[str]*            | :heavy_minus_sign:         | N/A                        |
+| `parent_span_id`           | *Optional[str]*            | :heavy_minus_sign:         | N/A                        |
+| `__pydantic_extra__`       | Dict[str, *Nullable[Any]*] | :heavy_minus_sign:         | N/A                        |

docs/components/chatgenerationparamsttl.md

@@ -1,4 +1,4 @@
-# TTL
+# ChatGenerationParamsTTL
 
 
 ## Values

docs/components/chatgenerationparamstype.md

@@ -0,0 +1,8 @@
+# ChatGenerationParamsType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `EPHEMERAL` | ephemeral   |

docs/components/chatgenerationtokenusage.md

@@ -1,12 +1,14 @@
 # ChatGenerationTokenUsage
 
+Token usage statistics
+
 
 ## Fields
 
 | Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      |
 | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `completion_tokens`                                                                              | *float*                                                                                          | :heavy_check_mark:                                                                               | N/A                                                                                              |
+| `completion_tokens`                                                                              | *float*                                                                                          | :heavy_check_mark:                                                                               | Number of tokens in the completion                                                               |
-| `prompt_tokens`                                                                                  | *float*                                                                                          | :heavy_check_mark:                                                                               | N/A                                                                                              |
+| `prompt_tokens`                                                                                  | *float*                                                                                          | :heavy_check_mark:                                                                               | Number of tokens in the prompt                                                                   |
-| `total_tokens`                                                                                   | *float*                                                                                          | :heavy_check_mark:                                                                               | N/A                                                                                              |
+| `total_tokens`                                                                                   | *float*                                                                                          | :heavy_check_mark:                                                                               | Total number of tokens                                                                           |
-| `completion_tokens_details`                                                                      | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `completion_tokens_details`                                                                      | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign:                                                                               | Detailed completion token usage                                                                  |
-| `prompt_tokens_details`                                                                          | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md)         | :heavy_minus_sign:                                                                               | N/A                                                                                              |
+| `prompt_tokens_details`                                                                          | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md)         | :heavy_minus_sign:                                                                               | Detailed prompt token usage                                                                      |

docs/components/chatmessagecontentitem.md

@@ -1,5 +1,7 @@
 # ChatMessageContentItem
 
+Content part for chat completion messages
+
 
 ## Supported Types
 
@@ -21,15 +23,15 @@ value: components.ChatMessageContentItemImage = /* values here */
 value: components.ChatMessageContentItemAudio = /* values here */
 ```
 
-### `components.ChatMessageContentItemVideo`
+### `components.ChatMessageContentItem1`
 
 ```python
-value: components.ChatMessageContentItemVideo = /* values here */
+value: components.ChatMessageContentItem1 = /* values here */
 ```
 
-### `components.ChatMessageContentItemVideo`
+### `components.ChatMessageContentItemFile`
 
 ```python
-value: components.ChatMessageContentItemVideo = /* values here */
+value: components.ChatMessageContentItemFile = /* values here */
 ```
 

docs/components/chatmessagecontentitem1.md

@@ -0,0 +1,17 @@
+# ChatMessageContentItem1
+
+
+## Supported Types
+
+### `components.ChatMessageContentItemVideoLegacy`
+
+```python
+value: components.ChatMessageContentItemVideoLegacy = /* values here */
+```
+
+### `components.ChatMessageContentItemVideo`
+
+```python
+value: components.ChatMessageContentItemVideo = /* values here */
+```
+

docs/components/chatmessagecontentitemaudio.md

@@ -1,9 +1,11 @@
 # ChatMessageContentItemAudio
 
+Audio input content part. Supported audio formats vary by provider.
+
 
 ## Fields
 
 | Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
 | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `type`                                                                                                     | *Literal["input_audio"]*                                                                                   | :heavy_check_mark:                                                                                         | N/A                                                                                                        |
+| `type`                                                                                                     | [components.ChatMessageContentItemAudioType](../components/chatmessagecontentitemaudiotype.md)             | :heavy_check_mark:                                                                                         | N/A                                                                                                        |
 | `input_audio`                                                                                              | [components.ChatMessageContentItemAudioInputAudio](../components/chatmessagecontentitemaudioinputaudio.md) | :heavy_check_mark:                                                                                         | N/A                                                                                                        |

docs/components/chatmessagecontentitemaudioinputaudio.md

@@ -3,7 +3,7 @@
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
+| Field                                                                                                       | Type                                                                                                        | Required                                                                                                    | Description                                                                                                 |
-| ------------------ | ------------------ | ------------------ | ------------------ |
+| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `data`             | *str*              | :heavy_check_mark: | N/A                |
+| `data`                                                                                                      | *str*                                                                                                       | :heavy_check_mark:                                                                                          | Base64 encoded audio data                                                                                   |
-| `format_`          | *str*              | :heavy_check_mark: | N/A                |
+| `format_`                                                                                                   | *str*                                                                                                       | :heavy_check_mark:                                                                                          | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. |

docs/components/chatmessagecontentitemaudiotype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemAudioType
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `INPUT_AUDIO` | input_audio   |

docs/components/chatmessagecontentitemcachecontrol.md

@@ -1,9 +1,11 @@
 # ChatMessageContentItemCacheControl
 
+Cache control for the content part
+
 
 ## Fields
 
-| Field                                            | Type                                             | Required                                         | Description                                      |
+| Field                                                                                                                | Type                                                                                                                 | Required                                                                                                             | Description                                                                                                          |
-| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `type`                                           | *Literal["ephemeral"]*                           | :heavy_check_mark:                               | N/A                                              |
+| `type`                                                                                                               | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md)         | :heavy_check_mark:                                                                                                   | N/A                                                                                                                  |
-| `ttl`                                            | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign:                               | N/A                                              |
+| `ttl`                                                                                                                | [Optional[components.ChatMessageContentItemCacheControlTTL]](../components/chatmessagecontentitemcachecontrolttl.md) | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |

docs/components/chatmessagecontentitemcachecontrolttl.md

@@ -0,0 +1,9 @@
+# ChatMessageContentItemCacheControlTTL
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `FIVEM` | 5m      |
+| `ONEH`  | 1h      |

docs/components/chatmessagecontentitemcachecontroltype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemCacheControlType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `EPHEMERAL` | ephemeral   |

docs/components/chatmessagecontentitemfile.md

@@ -0,0 +1,11 @@
+# ChatMessageContentItemFile
+
+File content part for document processing
+
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `type`                                                                                       | [components.ChatMessageContentItemFileType](../components/chatmessagecontentitemfiletype.md) | :heavy_check_mark:                                                                           | N/A                                                                                          |
+| `file`                                                                                       | [components.File](../components/file.md)                                                     | :heavy_check_mark:                                                                           | N/A                                                                                          |

docs/components/chatmessagecontentitemfiletype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemFileType
+
+
+## Values
+
+| Name   | Value  |
+| ------ | ------ |
+| `FILE` | file   |

docs/components/chatmessagecontentitemimage.md

@@ -1,9 +1,11 @@
 # ChatMessageContentItemImage
 
+Image content part for vision models
+
 
 ## Fields
 
-| Field                                            | Type                                             | Required                                         | Description                                      |
+| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `type`                                           | *Literal["image_url"]*                           | :heavy_check_mark:                               | N/A                                              |
+| `type`                                                                                                 | [components.ChatMessageContentItemImageType](../components/chatmessagecontentitemimagetype.md)         | :heavy_check_mark:                                                                                     | N/A                                                                                                    |
-| `image_url`                                      | [components.ImageURL](../components/imageurl.md) | :heavy_check_mark:                               | N/A                                              |
+| `image_url`                                                                                            | [components.ChatMessageContentItemImageImageURL](../components/chatmessagecontentitemimageimageurl.md) | :heavy_check_mark:                                                                                     | N/A                                                                                                    |

docs/components/chatmessagecontentitemimagedetail.md

@@ -1,5 +1,7 @@
 # ChatMessageContentItemImageDetail
 
+Image detail level for vision models
+
 
 ## Values
 

docs/components/chatmessagecontentitemimageimageurl.md

@@ -1,9 +1,9 @@
-# ImageURL
+# ChatMessageContentItemImageImageURL
 
 
 ## Fields
 
 | Field                                                                                                        | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
 | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `url`                                                                                                        | *str*                                                                                                        | :heavy_check_mark:                                                                                           | N/A                                                                                                          |
+| `url`                                                                                                        | *str*                                                                                                        | :heavy_check_mark:                                                                                           | URL of the image (data: URLs supported)                                                                      |
-| `detail`                                                                                                     | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |
+| `detail`                                                                                                     | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign:                                                                                           | Image detail level for vision models                                                                         |

docs/components/chatmessagecontentitemimagetype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemImageType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `IMAGE_URL` | image_url   |

docs/components/chatmessagecontentitemtext.md

@@ -1,10 +1,12 @@
 # ChatMessageContentItemText
 
+Text content part
+
 
 ## Fields
 
-| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
+| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    | Example                                                                                                        |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `type`                                                                                                         | *Literal["text"]*                                                                                              | :heavy_check_mark:                                                                                             | N/A                                                                                                            |
+| `type`                                                                                                         | [components.ChatMessageContentItemTextType](../components/chatmessagecontentitemtexttype.md)                   | :heavy_check_mark:                                                                                             | N/A                                                                                                            |                                                                                                                |
-| `text`                                                                                                         | *str*                                                                                                          | :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                                                                                                            |
+| `cache_control`                                                                                                | [Optional[components.ChatMessageContentItemCacheControl]](../components/chatmessagecontentitemcachecontrol.md) | :heavy_minus_sign:                                                                                             | Cache control for the content part                                                                             | {<br/>"type": "ephemeral",<br/>"ttl": "5m"<br/>}                                                               |

docs/components/chatmessagecontentitemtexttype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemTextType
+
+
+## Values
+
+| Name   | Value  |
+| ------ | ------ |
+| `TEXT` | text   |

docs/components/chatmessagecontentitemvideo.md

@@ -1,17 +1,11 @@
 # ChatMessageContentItemVideo
 
+Video input content part
 
-## Supported Types
 
-### `components.ChatMessageContentItemVideoInputVideo`
+## Fields
-
-```python
-value: components.ChatMessageContentItemVideoInputVideo = /* values here */
-```
-
-### `components.ChatMessageContentItemVideoVideoURL`
-
-```python
-value: components.ChatMessageContentItemVideoVideoURL = /* values here */
-```
 
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `type`                                                                                         | [components.ChatMessageContentItemVideoType](../components/chatmessagecontentitemvideotype.md) | :heavy_check_mark:                                                                             | N/A                                                                                            |
+| `video_url`                                                                                    | [components.VideoInput](../components/videoinput.md)                                           | :heavy_check_mark:                                                                             | Video input object                                                                             |

docs/components/chatmessagecontentitemvideoinputvideo.md

@@ -1,9 +0,0 @@
-# ChatMessageContentItemVideoInputVideo
-
-
-## Fields
-
-| Field                                              | Type                                               | Required                                           | Description                                        |
-| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
-| `type`                                             | *Literal["input_video"]*                           | :heavy_check_mark:                                 | N/A                                                |
-| `video_url`                                        | [components.VideoURL1](../components/videourl1.md) | :heavy_check_mark:                                 | N/A                                                |

docs/components/chatmessagecontentitemvideolegacy.md

@@ -0,0 +1,13 @@
+# ~~ChatMessageContentItemVideoLegacy~~
+
+Video input content part (legacy format - deprecated)
+
+> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
+
+
+## Fields
+
+| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `type`                                                                                                     | [components.ChatMessageContentItemVideoLegacyType](../components/chatmessagecontentitemvideolegacytype.md) | :heavy_check_mark:                                                                                         | N/A                                                                                                        |
+| `video_url`                                                                                                | [components.VideoInput](../components/videoinput.md)                                                       | :heavy_check_mark:                                                                                         | Video input object                                                                                         |

docs/components/chatmessagecontentitemvideolegacytype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemVideoLegacyType
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `INPUT_VIDEO` | input_video   |

docs/components/chatmessagecontentitemvideotype.md

@@ -0,0 +1,8 @@
+# ChatMessageContentItemVideoType
+
+
+## Values
+
+| Name        | Value       |
+| ----------- | ----------- |
+| `VIDEO_URL` | video_url   |

docs/components/chatmessagecontentitemvideovideourl.md

@@ -1,9 +0,0 @@
-# ChatMessageContentItemVideoVideoURL
-
-
-## Fields
-
-| Field                                              | Type                                               | Required                                           | Description                                        |
-| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
-| `type`                                             | *Literal["video_url"]*                             | :heavy_check_mark:                                 | N/A                                                |
-| `video_url`                                        | [components.VideoURL2](../components/videourl2.md) | :heavy_check_mark:                                 | N/A                                                |

docs/components/chatmessagetokenlogprob.md

@@ -1,11 +1,13 @@
 # ChatMessageTokenLogprob
 
+Token log probability information
+
 
 ## Fields
 
-| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `token`                                                    | *str*                                                      | :heavy_check_mark:                                         | N/A                                                        |
+| `token`                                                                                                  | *str*                                                                                                    | :heavy_check_mark:                                                                                       | The token                                                                                                |
-| `logprob`                                                  | *float*                                                    | :heavy_check_mark:                                         | N/A                                                        |
+| `logprob`                                                                                                | *float*                                                                                                  | :heavy_check_mark:                                                                                       | Log probability of the token                                                                             |
-| `bytes_`                                                   | List[*float*]                                              | :heavy_check_mark:                                         | N/A                                                        |
+| `bytes_`                                                                                                 | List[*float*]                                                                                            | :heavy_check_mark:                                                                                       | UTF-8 bytes of the token                                                                                 |
-| `top_logprobs`                                             | List[[components.TopLogprob](../components/toplogprob.md)] | :heavy_check_mark:                                         | N/A                                                        |
+| `top_logprobs`                                                                                           | List[[components.ChatMessageTokenLogprobTopLogprob](../components/chatmessagetokenlogprobtoplogprob.md)] | :heavy_check_mark:                                                                                       | Top alternative tokens with probabilities                                                                |

docs/components/chatmessagetokenlogprobs.md

@@ -1,9 +1,11 @@
 # ChatMessageTokenLogprobs
 
+Log probabilities for the completion
+
 
 ## Fields
 
 | Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `content`                                                                            | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark:                                                                   | N/A                                                                                  |
+| `content`                                                                            | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark:                                                                   | Log probabilities for content tokens                                                 |
-| `refusal`                                                                            | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark:                                                                   | N/A                                                                                  |
+| `refusal`                                                                            | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_minus_sign:                                                                   | Log probabilities for refusal tokens                                                 |

docs/components/chatmessagetokenlogprobtoplogprob.md

@@ -0,0 +1,10 @@
+# ChatMessageTokenLogprobTopLogprob
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `token`            | *str*              | :heavy_check_mark: | N/A                |
+| `logprob`          | *float*            | :heavy_check_mark: | N/A                |
+| `bytes_`           | List[*float*]      | :heavy_check_mark: | N/A                |

docs/components/chatmessagetoolcall.md

@@ -1,10 +1,12 @@
 # ChatMessageToolCall
 
+Tool call made by the assistant
+
 
 ## Fields
 
 | Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            |
 | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `id`                                                                                   | *str*                                                                                  | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `id`                                                                                   | *str*                                                                                  | :heavy_check_mark:                                                                     | Tool call identifier                                                                   |
-| `type`                                                                                 | *Literal["function"]*                                                                  | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `type`                                                                                 | [components.ChatMessageToolCallType](../components/chatmessagetoolcalltype.md)         | :heavy_check_mark:                                                                     | N/A                                                                                    |
 | `function`                                                                             | [components.ChatMessageToolCallFunction](../components/chatmessagetoolcallfunction.md) | :heavy_check_mark:                                                                     | N/A                                                                                    |

docs/components/chatmessagetoolcallfunction.md

@@ -3,7 +3,7 @@
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
+| Field                             | Type                              | Required                          | Description                       |
-| ------------------ | ------------------ | ------------------ | ------------------ |
+| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
-| `name`             | *str*              | :heavy_check_mark: | N/A                |
+| `name`                            | *str*                             | :heavy_check_mark:                | Function name to call             |
-| `arguments`        | *str*              | :heavy_check_mark: | N/A                |
+| `arguments`                       | *str*                             | :heavy_check_mark:                | Function arguments as JSON string |

docs/components/chatmessagetoolcalltype.md

@@ -0,0 +1,8 @@
+# ChatMessageToolCallType
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `FUNCTION` | function   |

docs/components/chatresponse.md

@@ -1,14 +1,16 @@
 # ChatResponse
 
+Chat completion response
+
 
 ## Fields
 
-| Field                                                                                      | Type                                                                                       | Required                                                                                   | Description                                                                                |
+| Field                                                                                                                                                                         | Type                                                                                                                                                                          | Required                                                                                                                                                                      | Description                                                                                                                                                                   | Example                                                                                                                                                                       |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id`                                                                                       | *str*                                                                                      | :heavy_check_mark:                                                                         | N/A                                                                                        |
+| `id`                                                                                                                                                                          | *str*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                            | Unique completion identifier                                                                                                                                                  | chatcmpl-123                                                                                                                                                                  |
-| `choices`                                                                                  | List[[components.ChatResponseChoice](../components/chatresponsechoice.md)]                 | :heavy_check_mark:                                                                         | N/A                                                                                        |
+| `choices`                                                                                                                                                                     | List[[components.ChatResponseChoice](../components/chatresponsechoice.md)]                                                                                                    | :heavy_check_mark:                                                                                                                                                            | List of completion choices                                                                                                                                                    |                                                                                                                                                                               |
-| `created`                                                                                  | *float*                                                                                    | :heavy_check_mark:                                                                         | N/A                                                                                        |
+| `created`                                                                                                                                                                     | *float*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                            | Unix timestamp of creation                                                                                                                                                    | 1677652288                                                                                                                                                                    |
-| `model`                                                                                    | *str*                                                                                      | :heavy_check_mark:                                                                         | N/A                                                                                        |
+| `model`                                                                                                                                                                       | *str*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                            | Model used for completion                                                                                                                                                     | openai/gpt-4                                                                                                                                                                  |
-| `object`                                                                                   | *Literal["chat.completion"]*                                                               | :heavy_check_mark:                                                                         | N/A                                                                                        |
+| `object`                                                                                                                                                                      | [components.ChatResponseObject](../components/chatresponseobject.md)                                                                                                          | :heavy_check_mark:                                                                                                                                                            | N/A                                                                                                                                                                           |                                                                                                                                                                               |
-| `system_fingerprint`                                                                       | *OptionalNullable[str]*                                                                    | :heavy_minus_sign:                                                                         | N/A                                                                                        |
+| `system_fingerprint`                                                                                                                                                          | *Nullable[str]*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                            | System fingerprint                                                                                                                                                            | fp_44709d6fcb                                                                                                                                                                 |
-| `usage`                                                                                    | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign:                                                                         | N/A                                                                                        |
+| `usage`                                                                                                                                                                       | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md)                                                                                    | :heavy_minus_sign:                                                                                                                                                            | Token usage statistics                                                                                                                                                        | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |

docs/components/chatresponsechoice.md

@@ -1,11 +1,13 @@
 # ChatResponseChoice
 
+Chat completion choice
+
 
 ## Fields
 
-| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        | Example                                                                                                            |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `finish_reason`                                                                                    | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md)     | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `finish_reason`                                                                                                    | *Nullable[Any]*                                                                                                    | :heavy_check_mark:                                                                                                 | N/A                                                                                                                |                                                                                                                    |
-| `index`                                                                                            | *float*                                                                                            | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `index`                                                                                                            | *float*                                                                                                            | :heavy_check_mark:                                                                                                 | Choice index                                                                                                       | 0                                                                                                                  |
-| `message`                                                                                          | [components.AssistantMessage](../components/assistantmessage.md)                                   | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `message`                                                                                                          | [components.AssistantMessage](../components/assistantmessage.md)                                                   | :heavy_check_mark:                                                                                                 | Assistant message for requests and responses                                                                       | {<br/>"role": "user",<br/>"content": "What is the capital of France?"<br/>}                                        |
-| `logprobs`                                                                                         | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `logprobs`                                                                                                         | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md)                 | :heavy_minus_sign:                                                                                                 | Log probabilities for the completion                                                                               | {<br/>"content": [<br/>{<br/>"token": " Hello",<br/>"logprob": -0.612345,<br/>"bytes": null,<br/>"top_logprobs": []<br/>}<br/>],<br/>"refusal": null<br/>} |

docs/components/chatresponseobject.md

@@ -0,0 +1,8 @@
+# ChatResponseObject
+
+
+## Values
+
+| Name              | Value             |
+| ----------------- | ----------------- |
+| `CHAT_COMPLETION` | chat.completion   |

docs/components/chatstreamingchoice.md

@@ -1,11 +1,13 @@
 # ChatStreamingChoice
 
+Streaming completion choice chunk
+
 
 ## Fields
 
-| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        | Example                                                                                                            |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `delta`                                                                                            | [components.ChatStreamingMessageChunk](../components/chatstreamingmessagechunk.md)                 | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `delta`                                                                                                            | [components.ChatStreamingMessageChunk](../components/chatstreamingmessagechunk.md)                                 | :heavy_check_mark:                                                                                                 | Delta changes in streaming response                                                                                | {<br/>"role": "assistant",<br/>"content": "Hello"<br/>}                                                            |
-| `finish_reason`                                                                                    | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md)     | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `finish_reason`                                                                                                    | *Nullable[Any]*                                                                                                    | :heavy_check_mark:                                                                                                 | N/A                                                                                                                |                                                                                                                    |
-| `index`                                                                                            | *float*                                                                                            | :heavy_check_mark:                                                                                 | N/A                                                                                                |
+| `index`                                                                                                            | *float*                                                                                                            | :heavy_check_mark:                                                                                                 | Choice index                                                                                                       | 0                                                                                                                  |
-| `logprobs`                                                                                         | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
+| `logprobs`                                                                                                         | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md)                 | :heavy_minus_sign:                                                                                                 | Log probabilities for the completion                                                                               | {<br/>"content": [<br/>{<br/>"token": " Hello",<br/>"logprob": -0.612345,<br/>"bytes": null,<br/>"top_logprobs": []<br/>}<br/>],<br/>"refusal": null<br/>} |

docs/components/chatstreamingmessagechunk.md

@@ -1,12 +1,16 @@
 # ChatStreamingMessageChunk
 
+Delta changes in streaming response
+
 
 ## Fields
 
-| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| Field                                                                                                                                                                                | Type                                                                                                                                                                                 | Required                                                                                                                                                                             | Description                                                                                                                                                                          | Example                                                                                                                                                                              |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `role`                                                                                               | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
+| `role`                                                                                                                                                                               | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md)                                                                                 | :heavy_minus_sign:                                                                                                                                                                   | The role of the message author                                                                                                                                                       | assistant                                                                                                                                                                            |
-| `content`                                                                                            | *OptionalNullable[str]*                                                                              | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
+| `content`                                                                                                                                                                            | *OptionalNullable[str]*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Message content delta                                                                                                                                                                | Hello                                                                                                                                                                                |
-| `reasoning`                                                                                          | *OptionalNullable[str]*                                                                              | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
+| `reasoning`                                                                                                                                                                          | *OptionalNullable[str]*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Reasoning content delta                                                                                                                                                              | I need to                                                                                                                                                                            |
-| `refusal`                                                                                            | *OptionalNullable[str]*                                                                              | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
+| `refusal`                                                                                                                                                                            | *OptionalNullable[str]*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                   | Refusal message delta                                                                                                                                                                | <nil>                                                                                                                                                                                |
-| `tool_calls`                                                                                         | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)]       | :heavy_minus_sign:                                                                                   | N/A                                                                                                  |
+| `tool_calls`                                                                                                                                                                         | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)]                                                                                       | :heavy_minus_sign:                                                                                                                                                                   | Tool calls delta                                                                                                                                                                     |                                                                                                                                                                                      |
+| `reasoning_details`                                                                                                                                                                  | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)]                                                                                                       | :heavy_minus_sign:                                                                                                                                                                   | Reasoning details for extended thinking models                                                                                                                                       |                                                                                                                                                                                      |
+| `audio`                                                                                                                                                                              | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md)                                                                                         | :heavy_minus_sign:                                                                                                                                                                   | N/A                                                                                                                                                                                  | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |

docs/components/chatstreamingmessagechunkrole.md

@@ -1,5 +1,7 @@
 # ChatStreamingMessageChunkRole
 
+The role of the message author
+
 
 ## Values
 

docs/components/chatstreamingmessagetoolcall.md

@@ -1,11 +1,13 @@
 # ChatStreamingMessageToolCall
 
+Tool call delta for streaming responses
+
 
 ## Fields
 
-| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
+| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        | Example                                                                                                            |
-| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `index`                                                                                                            | *float*                                                                                                            | :heavy_check_mark:                                                                                                 | N/A                                                                                                                |
+| `index`                                                                                                            | *float*                                                                                                            | :heavy_check_mark:                                                                                                 | Tool call index in the array                                                                                       | 0                                                                                                                  |
-| `id`                                                                                                               | *Optional[str]*                                                                                                    | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `id`                                                                                                               | *Optional[str]*                                                                                                    | :heavy_minus_sign:                                                                                                 | Tool call identifier                                                                                               | call_abc123                                                                                                        |
-| `type`                                                                                                             | *Optional[Literal["function"]]*                                                                                    | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `type`                                                                                                             | [Optional[components.ChatStreamingMessageToolCallType]](../components/chatstreamingmessagetoolcalltype.md)         | :heavy_minus_sign:                                                                                                 | Tool call type                                                                                                     | function                                                                                                           |
-| `function`                                                                                                         | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `function`                                                                                                         | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign:                                                                                                 | Function call details                                                                                              |                                                                                                                    |