openapi: 3.1.0
info:
  title: stdapi.ai
  description: AWS standardized AI API
  contact:
    name: stdapi.ai
    url: https://stdapi.jgoutin.dev/
  license:
    name: GNU Affero General Public License v3.0 or later
    identifier: AGPL-3.0-or-later
  version: 1.20.2
paths:
  /anthropic/v1/files:
    post:
      tags:
      - Files
      - Anthropic
      summary: Upload a file for use in other API endpoints (Anthropic format)
      description: 'Uploads a file and returns `FileMetadata` with the assigned file
        ID (Anthropic Files API).


        The returned `id` (format: `file_<32 hex chars>`) can be referenced in `anthropic_message`
        requests to supply documents or images without re-uploading them.


        **Providing the file:** Two request formats are accepted:

        - `multipart/form-data`: standard binary file upload via the `file` field.

        - `application/json`: pass `file` as a base64 string, data URI (`data:<mime>;base64,<data>`),
        HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot
        construct multipart requests.


        **MCP / AI agent usage:** Call this tool with a JSON body. To upload inline
        content use a data URI: `{"file": "data:text/plain;base64,SGVsbG8h"}`. To
        ingest a remote file pass its URL: `{"file": "https://example.com/document.pdf"}`.


        **File expiry:** Files persist until manually deleted unless `expires_in_seconds`
        is set (1 hour to 90 days from upload).'
      operationId: anthropic_file
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_anthropic_file'
          application/json:
            examples:
              data_uri:
                summary: Inline content via data URI (MCP / AI agent)
                value:
                  file: data:text/plain;base64,SGVsbG8gV29ybGQ=
              url:
                summary: Fetch from URL
                value:
                  file: https://example.com/document.pdf
      responses:
        '200':
          description: The file metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileMetadata'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Files
      - Anthropic
      summary: List uploaded files (Anthropic format)
      description: 'Returns a paginated list of uploaded files with metadata, most
        recently created first (Anthropic Files API).


        Walk the list by sending each response''s `next_page` value back as `page`,
        until `next_page` is null. The `after_id` and `before_id` ID cursors page
        the same list in either direction.


        Pass `ids` to fetch a known set of files in one call instead of paging through
        the whole list.'
      operationId: anthropic_file_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              pattern: ^file[-_][a-z0-9]{32}$
          - type: 'null'
          description: Restrict the result to the files whose ID is in this list,
            at most 100 after de-duplication. The whole selection is returned as a
            single page, so `after_id`, `before_id` and `limit` are ignored and `page`
            is refused; IDs naming no readable file are omitted instead of reported.
          title: Ids
        description: Restrict the result to the files whose ID is in this list, at
          most 100 after de-duplication. The whole selection is returned as a single
          page, so `after_id`, `before_id` and `limit` are ignored and `page` is refused;
          IDs naming no readable file are omitted instead of reported.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor served as `next_page` by a previous response. Returns
            the page that follows it; cannot be combined with `ids`, `after_id` or
            `before_id`.
          title: Page
        description: Cursor served as `next_page` by a previous response. Returns
          the page that follows it; cannot be combined with `ids`, `after_id` or `before_id`.
      - name: after_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^file[-_][a-z0-9]{32}$
          - type: 'null'
          description: ID of the object to use as a cursor for pagination. When provided,
            returns the page of results immediately after this object.
          title: After Id
        description: ID of the object to use as a cursor for pagination. When provided,
          returns the page of results immediately after this object.
      - name: before_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^file[-_][a-z0-9]{32}$
          - type: 'null'
          description: ID of the object to use as a cursor for pagination. When provided,
            returns the page of results immediately before this object.
          title: Before Id
        description: ID of the object to use as a cursor for pagination. When provided,
          returns the page of results immediately before this object.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Number of items to return per page. Defaults to `20`. Ranges
            from `1` to `1000`.
          default: 20
          title: Limit
        description: Number of items to return per page. Defaults to `20`. Ranges
          from `1` to `1000`.
      - name: scope_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Not available: files are not associated with a scope, so a
            request naming this parameter is refused.'
          title: Scope Id
        description: 'Not available: files are not associated with a scope, so a request
          naming this parameter is refused.'
      - name: ids[]
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              pattern: ^file[-_][a-z0-9]{32}$
          - type: 'null'
          description: The same filter as `ids`, under the key the Anthropic client
            writes a list to. Sending both merges them.
          title: Ids[]
        description: The same filter as `ids`, under the key the Anthropic client
          writes a list to. Sending both merges them.
      responses:
        '200':
          description: A list of file metadata objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/files/{file_id}:
    get:
      tags:
      - Files
      - Anthropic
      summary: Retrieve metadata for an uploaded file (Anthropic format)
      description: Returns metadata (name, size, MIME type, creation date) for a specific
        file by ID (Anthropic Files API).
      operationId: anthropic_files_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: ID of the File.
          title: File Id
        description: ID of the File.
      responses:
        '200':
          description: The file metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileMetadata'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Files
      - Anthropic
      summary: Delete an uploaded file (Anthropic format)
      description: Permanently deletes a file by ID and returns a deletion confirmation
        (Anthropic Files API).
      operationId: anthropic_files_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: ID of the File.
          title: File Id
        description: ID of the File.
      responses:
        '200':
          description: Deletion status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedFile'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/files/{file_id}/content:
    get:
      tags:
      - Files
      - Anthropic
      summary: Download the raw content of an uploaded file (Anthropic format)
      description: 'Returns the raw binary content of a file as a streaming download
        (Anthropic Files API).


        **MCP / AI agent usage:** text files come back as text and images as an image;
        any other content, and anything too large to carry, comes back as a JSON reference
        holding the URL to download it from.'
      operationId: anthropic_file_content
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: ID of the File.
          title: File Id
        description: ID of the File.
      responses:
        '200':
          description: The raw file content.
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/messages:
    post:
      tags:
      - Chat
      - Anthropic
      summary: Generate a message response (Anthropic format)
      description: 'Creates a message response (Anthropic Messages API).


        Accepts a structured list of input messages and generates the next message
        in the conversation. Returns a `Message` object, or a stream of `MessageStreamEvent`
        objects when `stream=true`.


        **Extended multimodal inputs (beyond original Anthropic API):**

        - **Images:** Supply images inline (base64/URL) or by Files API `file_id`
        obtained from `anthropic_file`.

        - **Documents:** Supply PDFs (base64/URL), plain text, or files by `file_id`.
        Citation extraction is supported.


        **Extended capabilities:**

        - **Extended thinking:** Control reasoning depth via `thinking` or `output_config.effort`
        (`low`, `medium`, `high`, `xhigh`, `max`).

        - **Server tools:** Built-in tools such as `web_search` can be enabled without
        custom implementations.


        **When to use:** Use this endpoint for Anthropic SDK compatibility or when
        you need extended thinking, citations, or Anthropic-specific features. For
        OpenAI SDK compatibility, use `openai_chat_completion` or `openai_response`
        instead.


        **Find compatible models:** Call `search_models` with `route=anthropic_message`
        to discover model IDs that support this endpoint. When supplying images or
        documents, also add `input_modalities=IMAGE` to the filter so only models
        that support both the route and image input are returned.'
      operationId: anthropic_message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageCreateParams'
            examples:
              basic:
                summary: Basic message
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Hello, how are you?
                  max_tokens: 1024
              streaming:
                summary: Streaming response
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Tell me a story
                  max_tokens: 1024
                  stream: true
              with_system:
                summary: With system prompt
                value:
                  model: amazon.nova-micro-v1:0
                  system: You are a helpful assistant.
                  messages:
                  - role: user
                    content: Explain quantum computing
                  max_tokens: 2048
                  temperature: 0.7
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              example:
                id: msg-f6ed35b89b77488f8c481eb0a26ac1bf
                type: message
                role: assistant
                content:
                - type: text
                  text: I'm an AI assistant.
                model: amazon.nova-micro-v1:0
                stop_reason: end_turn
                usage:
                  input_tokens: 11
                  output_tokens: 16
        '400':
          description: Invalid request or unsupported parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /anthropic/v1/messages/count_tokens:
    post:
      tags:
      - Chat
      - Anthropic
      summary: Count input tokens for a message without generating a response (Anthropic
        format)
      description: 'Counts the number of tokens a given request would consume, without
        creating a message.


        Accounts for all inputs — messages, system prompt, tools, images, and documents.
        Useful for estimating costs or checking whether a prompt fits within a model''s
        context window before making a full `anthropic_message` call.


        Every text model is counted: exactly where the model''s own counter serves
        it, otherwise as an approximation that is never below the exact count on the
        content measured.


        **Find compatible models:** Call `search_models` with `route=anthropic_message_count_tokens`
        to discover model IDs that support this endpoint.'
      operationId: anthropic_message_count_tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageCountTokensParams'
            examples:
              basic:
                summary: Basic count tokens
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Hello, how are you?
              with_system:
                summary: With system prompt
                value:
                  model: amazon.nova-micro-v1:0
                  system: You are a helpful assistant.
                  messages:
                  - role: user
                    content: Explain quantum computing
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageTokensCount'
              example:
                input_tokens: 2095
        '400':
          description: Invalid request or unsupported parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /anthropic/v1/messages/batches:
    post:
      tags:
      - Batches
      - Anthropic
      summary: Create a batch of message requests to run asynchronously (Anthropic
        format)
      description: 'Creates a Message Batch that runs many `anthropic_message` requests
        asynchronously, at the discounted batch price (Anthropic Message Batches API).


        A batch must carry at least 100 requests for each model it names, and may
        name at most 8 different models. Tool use, structured outputs and streaming
        are not available in a batch.


        Returns the `MessageBatch` immediately. Poll `anthropic_message_batch_get`
        until its `processing_status` is `ended`, then read `results_url` with `anthropic_message_batch_results`.
        Results may come back in any order — match them to the requests by `custom_id`.'
      operationId: anthropic_message_batch
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageBatchCreateParams'
      responses:
        '200':
          description: Message Batch created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageBatch'
        '400':
          description: Invalid request or unsupported parameters.
        '503':
          description: The Message Batches API is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Batches
      - Anthropic
      summary: List Message Batches (Anthropic format)
      description: Returns a paginated list of Message Batches, newest first (Anthropic
        Message Batches API).
      operationId: anthropic_message_batch_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: before_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^msgbatch_[a-z0-9]{32}$
          - type: 'null'
          description: 'Cursor for pagination: return the page immediately before
            this Message Batch ID.'
          title: Before Id
        description: 'Cursor for pagination: return the page immediately before this
          Message Batch ID.'
      - name: after_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^msgbatch_[a-z0-9]{32}$
          - type: 'null'
          description: 'Cursor for pagination: return the page immediately after this
            Message Batch ID.'
          title: After Id
        description: 'Cursor for pagination: return the page immediately after this
          Message Batch ID.'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Number of items to return per page.
          default: 20
          title: Limit
        description: Number of items to return per page.
      responses:
        '200':
          description: A paginated list of Message Batch objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageBatchList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/messages/batches/{message_batch_id}:
    get:
      tags:
      - Batches
      - Anthropic
      summary: Retrieve a Message Batch (Anthropic format)
      description: Returns the current state of a Message Batch (Anthropic Message
        Batches API). Poll this endpoint until `processing_status` is `ended`, then
        read the results with `anthropic_message_batch_results`.
      operationId: anthropic_message_batch_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: message_batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^msgbatch_[a-z0-9]{32}$
          description: ID of the Message Batch.
          title: Message Batch Id
        description: ID of the Message Batch.
      responses:
        '200':
          description: The Message Batch state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageBatch'
        '404':
          description: Message Batch not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Batches
      - Anthropic
      summary: Delete a Message Batch (Anthropic format)
      description: Deletes a Message Batch and its results (Anthropic Message Batches
        API). Only a batch whose `processing_status` is `ended` can be deleted; cancel
        it first with `anthropic_message_batch_cancel` if it is still processing.
      operationId: anthropic_message_batch_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: message_batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^msgbatch_[a-z0-9]{32}$
          description: ID of the Message Batch.
          title: Message Batch Id
        description: ID of the Message Batch.
      responses:
        '200':
          description: Message Batch deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedMessageBatch'
        '400':
          description: The Message Batch is still processing.
        '404':
          description: Message Batch not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/messages/batches/{message_batch_id}/results:
    get:
      tags:
      - Batches
      - Anthropic
      summary: Stream the results of a Message Batch (Anthropic format)
      description: Streams the results of a Message Batch as JSONL, one result per
        line (Anthropic Message Batches API). Available only once `processing_status`
        is `ended`. Results may come back in any order — match them to the requests
        by `custom_id`.
      operationId: anthropic_message_batch_results
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: message_batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^msgbatch_[a-z0-9]{32}$
          description: ID of the Message Batch.
          title: Message Batch Id
        description: ID of the Message Batch.
      responses:
        '200':
          description: The results.
          content:
            application/json:
              schema: {}
        '404':
          description: Message Batch not found or not ended yet.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/messages/batches/{message_batch_id}/cancel:
    post:
      tags:
      - Batches
      - Anthropic
      summary: Cancel a Message Batch (Anthropic format)
      description: Cancels a Message Batch that is still processing (Anthropic Message
        Batches API). The batch moves to `canceling` and then to `ended`; requests
        that already produced a Message keep it and stay readable in the results,
        and the ones that never ran are reported `canceled`. Cancelling a batch that
        has already ended changes nothing.
      operationId: anthropic_message_batch_cancel
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: message_batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^msgbatch_[a-z0-9]{32}$
          description: ID of the Message Batch.
          title: Message Batch Id
        description: ID of the Message Batch.
      responses:
        '200':
          description: Cancellation started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageBatch'
        '404':
          description: Message Batch not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/models:
    get:
      tags:
      - Models
      - Anthropic
      summary: List available text generation models (Anthropic format)
      description: 'Lists all available text generation models with display name and
        creation date (Anthropic Models API). Only models that support text input
        and output are included.


        **Agent note:** For richer filtering — by modality, route, MCP tool, region,
        or legacy status — use `search_models` instead.'
      operationId: anthropic_model_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: Number of items to return per page.
          default: 1000
          title: Limit
        description: Number of items to return per page.
      - name: after_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the object to use as a cursor for pagination. When provided,
            returns the page of results immediately after this object.
          title: After Id
        description: ID of the object to use as a cursor for pagination. When provided,
          returns the page of results immediately after this object.
      - name: before_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the object to use as a cursor for pagination. When provided,
            returns the page of results immediately before this object.
          title: Before Id
        description: ID of the object to use as a cursor for pagination. When provided,
          returns the page of results immediately before this object.
      responses:
        '200':
          description: List of available models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelListResponse'
              examples:
                list:
                  summary: Example list
                  value:
                    data:
                    - id: amazon.nova-micro-v1:0
                      type: model
                      display_name: Amazon Nova Micro
                      created_at: '2025-01-01T00:00:00Z'
                    has_more: false
                    first_id: amazon.nova-micro-v1:0
                    last_id: amazon.nova-micro-v1:0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /anthropic/v1/models/{model_id}:
    get:
      tags:
      - Models
      - Anthropic
      summary: Retrieve details for a specific model by ID (Anthropic format)
      description: 'Retrieves metadata (display name, creation date) for a single
        model by ID (Anthropic Models API).


        **Agent note:** Use `search_models` to look up modalities, supported routes,
        regions, and other extended metadata not available here.'
      operationId: anthropic_model_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
          description: The ID of the model to retrieve.
          examples:
          - amazon.nova-micro-v1:0
          title: Model Id
        description: The ID of the model to retrieve.
      responses:
        '200':
          description: Model retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelInfo'
              examples:
                model:
                  summary: Example model
                  value:
                    id: amazon.nova-micro-v1:0
                    type: model
                    display_name: Amazon Nova Micro
                    created_at: '2025-01-01T00:00:00Z'
        '404':
          description: Model not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /cohere/v2/embed:
    post:
      tags:
      - Embeddings
      - Cohere
      summary: Generate text embeddings as numeric vectors (Cohere format)
      description: 'Creates embedding vector(s) for the input texts, images, or mixed
        text and image `inputs` (Cohere v2 Embed API).


        Returns fixed-dimensional float vectors suitable for semantic search, clustering,
        and retrieval-augmented generation, one per input and in request order. Works
        with every available embedding model; the Cohere-specific `input_type`, `truncate`,
        and `max_tokens` parameters are applied to Cohere models and ignored for providers
        without an equivalent.


        **Find compatible models:** Call `search_models` with `route=cohere_embed`
        to discover model IDs that support embeddings.'
      operationId: cohere_embed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stdapi__types__cohere_embed__EmbedRequest'
            examples:
              texts:
                summary: Embed texts
                value:
                  model: cohere.embed-multilingual-v3
                  input_type: search_document
                  texts:
                  - Hello world
                  - Bonjour le monde
        required: true
      responses:
        '200':
          description: Embeddings successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__cohere_embed__EmbedResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /cohere/v1/embed:
    post:
      tags:
      - Embeddings
      - Cohere
      summary: Generate text embeddings as numeric vectors (Cohere v1 format)
      description: 'Creates embedding vector(s) for the input texts or images (legacy
        Cohere v1 Embed API).


        Provided for compatibility with older Cohere SDKs and integrations; new clients
        should prefer the v2 `cohere_embed` endpoint. Returns the legacy `embeddings_floats`
        shape (a plain list of float vectors) unless `embedding_types` is provided,
        in which case embeddings are grouped by type. The optional `input_type` and
        `truncate` parameters are applied to Cohere models and ignored for providers
        without an equivalent.


        **Find compatible models:** Call `search_models` with `route=cohere_embed_v1`
        to discover model IDs that support embeddings.'
      operationId: cohere_embed_v1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbedV1Request'
            examples:
              texts:
                summary: Embed texts
                value:
                  model: cohere.embed-multilingual-v3
                  input_type: search_document
                  texts:
                  - Hello world
                  - Bonjour le monde
        required: true
      responses:
        '200':
          description: Embeddings successfully created.
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/EmbedV1FloatsResponse'
                - $ref: '#/components/schemas/stdapi__types__cohere_embed__EmbedResponse'
                title: Response Cohere Embed V1
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /cohere/v2/rerank:
    post:
      tags:
      - Rerank
      - Cohere
      summary: Rank documents by relevance to a query (Cohere format)
      description: 'Ranks the provided documents by semantic relevance to the query
        (Cohere v2 Rerank API).


        Returns one result per document (or the `top_n` most relevant ones), ordered
        by decreasing `relevance_score`. Ideal as the second stage of a retrieval
        pipeline, after a vector or keyword search.


        **Find compatible models:** Call `search_models` with `route=cohere_rerank`
        to discover model IDs that support reranking.'
      operationId: cohere_rerank
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerankRequest'
            examples:
              rerank:
                summary: Rerank documents
                value:
                  model: cohere.rerank-v3-5:0
                  query: What is the capital of the United States?
                  documents:
                  - Carson City is the capital city of Nevada.
                  - Washington, D.C. is the capital of the United States.
                  top_n: 1
        required: true
      responses:
        '200':
          description: Documents successfully reranked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerankResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /cohere/v1/rerank:
    post:
      tags:
      - Rerank
      - Cohere
      summary: Rank documents by relevance to a query (Cohere v1 format)
      description: 'Ranks the provided documents by semantic relevance to the query
        (legacy Cohere v1 Rerank API).


        Provided for compatibility with older Cohere SDKs and integrations; new clients
        should prefer the v2 `cohere_rerank` endpoint. Documents may be plain strings
        or field->value objects; `rank_fields` selects which object fields are ranked
        on, and `return_documents` echoes the documents back in the results.


        **Find compatible models:** Call `search_models` with `route=cohere_rerank_v1`
        to discover model IDs that support reranking.'
      operationId: cohere_rerank_v1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerankV1Request'
            examples:
              rerank:
                summary: Rerank documents
                value:
                  model: cohere.rerank-v3-5:0
                  query: What is the capital of the United States?
                  documents:
                  - Carson City is the capital city of Nevada.
                  - Washington, D.C. is the capital of the United States.
                  top_n: 1
        required: true
      responses:
        '200':
          description: Documents successfully reranked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerankV1Response'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /search_models:
    get:
      tags:
      - Models
      summary: Search available models with optional filters
      description: 'Search the catalogue of currently available models and return
        extended metadata (modalities, supported API routes, MCP tool names, regions,
        streaming support, Batch API support, legacy status). Supplements the standard
        `/v1/models` list.


        All filters are optional and combined with **AND** logic — only models matching
        every supplied filter are returned, sorted by ID.


        **Agent workflow:**

        1. Call this tool first to find the right model ID, then pass it to the target
        endpoint.

        2. Use `route` with either a route path **or** an MCP tool name — both are
        accepted transparently (e.g. `route=/v1/images/generations` and `route=openai_image_generation`
        return the same models).

        3. **Combine filters for multimodal tasks:** when a tool supports extended
        input modalities (e.g. images in `openai_chat_completion`), add `input_modalities=IMAGE`
        alongside `route` — this ensures the model supports *both* the route and the
        required modality. A model that only handles text would otherwise appear in
        a route-only search and then fail at request time.

        4. **Legacy models are excluded by default.** Add `legacy=true` if you specifically
        need a deprecated model (e.g. to check what it should be migrated to).

        5. Use `model` with a wildcard pattern to see everything that pattern matches,
        newest first, before sending it as a model name on a request.


        **Examples:**

        - Text generation: `route=openai_chat_completion`

        - Vision (image input): `route=openai_chat_completion&input_modalities=IMAGE`

        - Audio understanding: `route=openai_chat_completion&input_modalities=SPEECH`

        - Embeddings: `route=openai_embedding`

        - Image generation: `route=openai_image_generation`

        - Live speech-to-speech: `route=openai_realtime`

        - Batch-capable chat models: `route=openai_chat_completion&batch=true`

        - Batch-capable embedding models: `route=openai_embedding&batch=true`


        **Note:** Audio *output* from `openai_chat_completion` (via `modalities=["text","audio"]`)
        is a model-specific capability not separately tracked — use a `route` search
        and verify audio output support in the model documentation. The built-in `web_search`
        tool on `openai_response` is model-specific and not tracked either.'
      operationId: search_models
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: input_modalities
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            uniqueItems: true
            items:
              type: string
          - type: 'null'
          description: Filter by expected input modalities (e.g., TEXT, IMAGE, SPEECH).
          title: Input Modalities
        description: Filter by expected input modalities (e.g., TEXT, IMAGE, SPEECH).
      - name: output_modalities
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            uniqueItems: true
            items:
              type: string
          - type: 'null'
          description: Filter by expected output modalities (e.g., TEXT, IMAGE, AUDIO).
          title: Output Modalities
        description: Filter by expected output modalities (e.g., TEXT, IMAGE, AUDIO).
      - name: route
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter to models that support a specific route path (e.g. /v1/chat/completions)
            or MCP tool name (e.g. openai_chat_completion). Both formats are accepted
            transparently.
          title: Route
        description: Filter to models that support a specific route path (e.g. /v1/chat/completions)
          or MCP tool name (e.g. openai_chat_completion). Both formats are accepted
          transparently.
      - name: region
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter to models available in a specific AWS region (e.g. us-east-1).
          title: Region
        description: Filter to models available in a specific AWS region (e.g. us-east-1).
      - name: streaming
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter by streaming support (true = streaming only, false =
            non-streaming only).
          title: Streaming
        description: Filter by streaming support (true = streaming only, false = non-streaming
          only).
      - name: batch
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: 'Filter by advertised Batch API support (true = batch-capable
            models only, false = the rest). Best effort: a model not advertised may
            still be accepted, so submit the batch rather than ruling a model out.'
          title: Batch
        description: 'Filter by advertised Batch API support (true = batch-capable
          models only, false = the rest). Best effort: a model not advertised may
          still be accepted, so submit the batch rather than ruling a model out.'
      - name: legacy
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter by legacy status (true = deprecated models only, false
            = non-deprecated models only). Legacy models are excluded when omitted;
            pass legacy=true to list them.
          title: Legacy
        description: Filter by legacy status (true = deprecated models only, false
          = non-deprecated models only). Legacy models are excluded when omitted;
          pass legacy=true to list them.
      - name: model
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            maxLength: 255
          - type: 'null'
          description: Filter to the models a name or a wildcard pattern matches,
            by ID or by alternative name (e.g. claude-sonnet-*). Returns the whole
            match set newest first -- everything the pattern could select, not just
            the one it would on a request, since a tie, a route mismatch, a deprecated
            match or a pending-subscription match changes what a request actually
            resolves to. Add `route` to narrow it to one endpoint, as a pattern on
            a request is scoped. Models with no known release date come last and are
            never selected.
          title: Model
        description: Filter to the models a name or a wildcard pattern matches, by
          ID or by alternative name (e.g. claude-sonnet-*). Returns the whole match
          set newest first -- everything the pattern could select, not just the one
          it would on a request, since a tie, a route mismatch, a deprecated match
          or a pending-subscription match changes what a request actually resolves
          to. Add `route` to narrow it to one endpoint, as a pattern on a request
          is scoped. Models with no known release date come last and are never selected.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModelDetails'
                title: Response Search Models
        '400':
          description: Invalid modality, route, or MCP tool filter.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /model_pricing:
    get:
      tags:
      - Models
      summary: Get exact unit prices for one or more models
      description: 'Return the exact published unit prices for the requested models
        (or every available model when `model` is omitted), from the same catalog
        used for request cost tracking.


        Each row is one published price: a billed dimension (same vocabulary as the
        request-log usage entries) plus its published variants — service tier, prompt-cache
        write TTL, serving profile (routing), media spec (e.g. image resolution:quality),
        and long-context bucket. `unit_price` is an exact decimal string per **one**
        billed unit (token, image, second, character, request, search unit) in `currency`.


        By default the card reflects **this server''s configuration**: only the regions
        this server is configured for, the model''s default service tier, and its
        effective serving profile (routing), with the same fallbacks billing applies.
        Pass `all_prices=true` for the model''s full published price table, and explicit
        `region`/`tier`/`routing` filters to override any axis in either mode.


        A few rates are priced under an identifier of their own and are not part of
        the unfiltered listing: pass `model=amazon.bedrock-web-search` for the built-in
        web search tool''s per-query rate (`grounding_requests`), or a guardrail policy''s
        own identifier.


        Prices are indexed eagerly: models not currently accessible to this deployment
        can still be priced. An empty `prices` list means no rate is published for
        that model (or none match the filters). A missing variant row means no distinct
        rate is published for it — billing then falls back the same way cost tracking
        does.


        All filters are optional and combined with **AND** logic.


        **Agent workflow:**

        1. Call `search_models` first to shortlist model IDs for the task.

        2. Call this tool with the shortlist (repeat `model`) and compare.

        3. Keep responses small: use `variants=false` for the base price card and
        `dimension` filters for token-only comparisons.


        **Examples:**

        - Card of a shortlist as billed here: `model=A&model=B`

        - Every available model as billed here: no parameters

        - Full published table: `model=A&all_prices=true`

        - Token rates in one region: `model=A&region=us-east-1&dimension=input_tokens&dimension=output_tokens`

        - Latency-optimized premium: `model=A&routing=latency`


        Requires cost tracking to be enabled (`COST_TRACKING` setting).'
      operationId: model_pricing
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: model
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
            minItems: 1
          - type: 'null'
          description: Model IDs or aliases to price (repeat for several). Omit for
            the full list of available models.
          title: Model
        description: Model IDs or aliases to price (repeat for several). Omit for
          the full list of available models.
      - name: region
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only prices for this AWS region (e.g. us-east-1).
          title: Region
        description: Only prices for this AWS region (e.g. us-east-1).
      - name: tier
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only this service tier (standard, flex, priority, batch).
          title: Tier
        description: Only this service tier (standard, flex, priority, batch).
      - name: dimension
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            uniqueItems: true
            items:
              type: string
          - type: 'null'
          description: Only these billed dimensions (e.g. input_tokens, output_tokens;
            repeat for several).
          title: Dimension
        description: Only these billed dimensions (e.g. input_tokens, output_tokens;
          repeat for several).
      - name: variants
        in: query
        required: false
        schema:
          type: boolean
          description: 'false = base price card only: standard tier without cache-TTL,
            routing, or long-context variant rows (media spec rows are kept).'
          default: true
          title: Variants
        description: 'false = base price card only: standard tier without cache-TTL,
          routing, or long-context variant rows (media spec rows are kept).'
      - name: currency
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only prices in this ISO currency code (e.g. USD, EUR).
          title: Currency
        description: Only prices in this ISO currency code (e.g. USD, EUR).
      - name: routing
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only this published serving-profile price variant (global or
            latency). Row `routing` values enriched for display -- geography prefixes
            like eu/us, or AWS regions -- cannot be filtered on; use `region` for
            those.
          title: Routing
        description: Only this published serving-profile price variant (global or
          latency). Row `routing` values enriched for display -- geography prefixes
          like eu/us, or AWS regions -- cannot be filtered on; use `region` for those.
      - name: context
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only this context-length bucket (long).
          title: Context
        description: Only this context-length bucket (long).
      - name: all_prices
        in: query
        required: false
        schema:
          type: boolean
          description: 'true = the model''s full published price table. false (default)
            = only the prices matching this server''s configuration: the regions this
            server is configured for, the model''s default service tier, and its effective
            serving profile (routing), with the same fallbacks billing applies.'
          default: false
          title: All Prices
        description: 'true = the model''s full published price table. false (default)
          = only the prices matching this server''s configuration: the regions this
          server is configured for, the model''s default service tier, and its effective
          serving profile (routing), with the same fallbacks billing applies.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModelPricing'
                title: Response Model Pricing
        '400':
          description: Invalid tier, dimension, routing, or context filter.
        '503':
          description: Model pricing is not available on this server, or the price
            catalog is not loaded yet (retry later).
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ollama/api/chat:
    post:
      tags:
      - Chat
      - Ollama
      summary: Generate a chat response (Ollama format)
      description: 'Creates a model response for the given conversation (Ollama Chat
        API).


        Supports tool calling, images, structured output through `format`, and thinking
        through `think`. Streams newline-delimited JSON objects by default; set `stream`
        to false for a single response object.


        Use the model names `ollama_tags` publishes. `logprobs` and `top_logprobs`
        are not available, and runner options such as `num_ctx` or `num_gpu`, along
        with `keep_alive`, are accepted and ignored.'
      operationId: ollama_chat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatRequest'
            examples:
              basic:
                summary: Single-turn chat
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Hello, how are you?
                  stream: false
        required: true
      responses:
        '200':
          description: The response was generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/embed:
    post:
      tags:
      - Embeddings
      - Ollama
      summary: Generate text embeddings as numeric vectors (Ollama format)
      description: 'Creates embedding vector(s) for the input text (Ollama Embed API).


        Accepts a single string or an array of strings and returns one vector per
        input, in request order. `dimensions` selects the vector width on models that
        support it. `truncate`, `keep_alive` and `options` have no effect and are
        accepted and ignored.


        Use the model names `ollama_tags` publishes.'
      operationId: ollama_embed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stdapi__types__ollama__EmbedRequest'
            examples:
              batch:
                summary: Embed texts
                value:
                  model: amazon.titan-embed-text-v2:0
                  input:
                  - first
                  - second
        required: true
      responses:
        '200':
          description: Embeddings successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__ollama__EmbedResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/embeddings:
    post:
      tags:
      - Embeddings
      - Ollama
      summary: Generate a text embedding as a numeric vector (Ollama legacy format)
      description: 'Creates one embedding vector for `prompt` (Ollama legacy Embeddings
        API).


        Superseded upstream by `ollama_embed`, which embeds several inputs at once
        and reports token usage. Kept for clients that still call it.'
      operationId: ollama_embeddings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingsRequest'
        required: true
      responses:
        '200':
          description: The embedding was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingsResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/generate:
    post:
      tags:
      - Completions
      - Ollama
      summary: Generate a response for a single prompt (Ollama format)
      description: 'Creates a model response for a single `prompt` (Ollama Generate
        API).


        Supports images, structured output through `format`, and thinking through
        `think`. Streams newline-delimited JSON objects by default; set `stream` to
        false for a single response object.


        `raw`, `suffix`, `template` and `context` need the model''s own prompt template
        and are not available; `logprobs` and `top_logprobs` are not available either.
        Send `prompt` with `system`, or use `ollama_chat` for a conversation.'
      operationId: ollama_generate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateRequest'
            examples:
              basic:
                summary: Single prompt
                value:
                  model: amazon.nova-micro-v1:0
                  prompt: Why is the sky blue?
                  stream: false
        required: true
      responses:
        '200':
          description: The response was generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/pull:
    post:
      tags:
      - Models
      - Ollama
      summary: Make a model available (Ollama format)
      description: 'Makes a model available for use (Ollama Pull API).


        Models are hosted and available as soon as they appear in `ollama_tags`, so
        nothing is transferred and the call reports success immediately; a model this
        server does not offer answers 404. `insecure` is accepted and ignored.'
      operationId: ollama_pull
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PullRequest'
        required: true
      responses:
        '200':
          description: The model is available.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/create:
    post:
      tags:
      - Models
      - Ollama
      summary: Create a model (Ollama format)
      description: UNSUPPORTED (Ollama Create API). This server offers hosted models
        and stores none of its own, so a model cannot be created here.
      operationId: ollama_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRequest'
        required: true
      responses:
        '200':
          description: Always an error.
          content:
            application/json:
              schema: {}
        '403':
          description: Models cannot be created on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/copy:
    post:
      tags:
      - Models
      - Ollama
      summary: Copy a model (Ollama format)
      description: UNSUPPORTED (Ollama Copy API). This server offers hosted models
        and stores none of its own, so a model cannot be copied here.
      operationId: ollama_copy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyRequest'
        required: true
      responses:
        '200':
          description: Always an error.
          content:
            application/json:
              schema: {}
        '403':
          description: Models cannot be copied on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/push:
    post:
      tags:
      - Models
      - Ollama
      summary: Publish a model (Ollama format)
      description: UNSUPPORTED (Ollama Push API). This server offers hosted models
        and publishes none, so a model cannot be pushed from here.
      operationId: ollama_push
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushRequest'
        required: true
      responses:
        '200':
          description: Always an error.
          content:
            application/json:
              schema: {}
        '403':
          description: Models cannot be published from this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/delete:
    delete:
      tags:
      - Models
      - Ollama
      summary: Delete a model (Ollama format)
      description: UNSUPPORTED (Ollama Delete API). This server offers hosted models
        and stores none of its own, so a model cannot be deleted here. Reporting success
        would tell the caller a model went away when it did not.
      operationId: ollama_delete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRequest'
        required: true
      responses:
        '200':
          description: Always an error.
          content:
            application/json:
              schema: {}
        '403':
          description: Models cannot be deleted on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/blobs/{digest}:
    post:
      tags:
      - Models
      - Ollama
      summary: Push a blob (Ollama format)
      description: UNSUPPORTED (Ollama Push a Blob API). A blob is uploaded only to
        build a model from it, which this server offers no way to do, so there is
        nothing to upload it into.
      operationId: ollama_blob_push
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: digest
        in: path
        required: true
        schema:
          type: string
          description: Digest of the blob, as `sha256:<hex>`.
          title: Digest
        description: Digest of the blob, as `sha256:<hex>`.
      responses:
        '200':
          description: Always an error.
          content:
            application/json:
              schema: {}
        '403':
          description: Blobs cannot be stored on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ollama/api/tags:
    get:
      tags:
      - Models
      - Ollama
      summary: List available models (Ollama format)
      description: 'Lists the models this server can serve through the Ollama endpoints
        (Ollama Tags API).


        Models are named by their canonical identifier, which is the name to send
        as `model`; short names accepted elsewhere on this server keep working. `size`
        is always 0 and `digest` is a stable identifier derived from the model name,
        since no model file is stored here.'
      operationId: ollama_tags
      responses:
        '200':
          description: The available models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/show:
    post:
      tags:
      - Models
      - Ollama
      summary: Show information about a model (Ollama format)
      description: 'Returns the details and capabilities of one model (Ollama Show
        API).


        `license`, `modelfile`, `template`, `parameters` and `system` describe a local
        model file and are omitted, as Ollama Cloud omits them for a cloud-hosted
        model; the parameter and quantization details are empty for the same reason.
        `capabilities` is a best-effort hint, not a contract.'
      operationId: ollama_show
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShowRequest'
        required: true
      responses:
        '200':
          description: The model details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShowResponse'
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/ps:
    get:
      tags:
      - Models
      - Ollama
      summary: List the models loaded in memory (Ollama format)
      description: 'Lists the models currently loaded in memory (Ollama Ps API).


        Always empty: models are served on demand and none is ever resident, so nothing
        has to be loaded before a request or unloaded after it.'
      operationId: ollama_ps
      responses:
        '200':
          description: The loaded models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PsResponse'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /ollama/api/version:
    get:
      tags:
      - Models
      - Ollama
      summary: Get the Ollama API version (Ollama format)
      description: 'Returns the Ollama API version this server is compatible with
        (Ollama Version API).


        A compatibility declaration, not this server''s own version: clients use it
        to decide which features of the Ollama API they may send.'
      operationId: ollama_version
      responses:
        '200':
          description: The version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/audio/speech:
    post:
      tags:
      - Audio
      - OpenAI
      summary: Convert text to speech audio (OpenAI format)
      description: 'Generates audio from the input text (OpenAI Audio Speech API).


        Returns the audio file as a streaming download in the requested format, or
        a stream of SSE audio events when `stream_format=sse`.


        Provider-specific parameters may return a non-audio payload instead: requesting
        speech marks (`SpeechMarkTypes`) returns timing marks as an `application/x-json-stream`
        JSON lines stream, which ignores `response_format` and does not support `stream_format=sse`.


        The maximum `input` length depends on the selected voice and on this server''s
        configuration; a request that exceeds it is rejected with the length that
        is accepted. Beyond a few thousand characters the audio takes proportionally
        longer to return, except with voices that stream it as it is spoken.


        **MCP / AI agent usage:** SSE audio events are the default; set `stream_format=audio`
        to receive the clip as a single audio result instead.


        **Find compatible models:** Call `search_models` with `route=openai_audio_speech`
        to discover model IDs that support text-to-speech.'
      operationId: openai_audio_speech
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpeechCreateParams'
            examples:
              file:
                summary: Generate MP3 file
                value:
                  model: amazon.polly-standard
                  voice: Amy
                  input: Hello, I'am Amy
                  response_format: mp3
              sse:
                summary: Stream using SSE
                value:
                  model: amazon.polly-standard
                  voice: Amy
                  input: Hello, I'am Amy
                  response_format: mp3
                  stream_format: sse
        required: true
      responses:
        '200':
          description: Audio generated (or streaming).
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/audio/transcriptions:
    post:
      tags:
      - Audio
      - OpenAI
      summary: Transcribe audio to text (OpenAI format)
      description: 'Transcribes audio into the input language (OpenAI Audio Transcriptions
        API).


        **Providing the audio file:** Two request formats are accepted:

        - `multipart/form-data`: standard binary file upload via the `file` field.

        - `application/json`: pass `file` as a base64 string, data URI (`data:audio/<fmt>;base64,<data>`),
        HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot
        construct multipart requests.


        **MCP / AI agent usage:** Call this tool with a JSON body containing the audio
        as a data URI or URL, along with `model` and any other parameters. Example:
        `{"file": "data:audio/mp3;base64,<data>", "model": "amazon.transcribe", "response_format":
        "json"}`.


        Returns the transcription as plain text, JSON with metadata, subtitle formats
        (SRT/VTT), or a stream of SSE events.


        **Extended output format (beyond original OpenAI API):**

        - **`diarized_json`**: Speaker diarization — returns labelled segments identifying
        which speaker said what, with timestamps. With `stream=true` each segment
        arrives as its own `transcript.text.segment` event.


        **Find compatible models:** Call `search_models` with `route=openai_audio_transcription`
        to discover model IDs that support speech-to-text.'
      operationId: openai_audio_transcription
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_audio_transcription'
            examples:
              json:
                summary: JSON response
                value:
                  model: amazon.transcribe
                  response_format: json
              vtt:
                summary: Subtitle (VTT)
                value:
                  response_format: vtt
              stream:
                summary: Streaming SSE
                value:
                  stream: true
          application/json:
            examples:
              data_uri:
                summary: Audio via data URI (MCP / AI agent)
                value:
                  file: data:audio/mp3;base64,<base64-encoded-audio>
                  model: amazon.transcribe
                  response_format: json
              url:
                summary: Audio from URL
                value:
                  file: https://example.com/audio.mp3
                  model: amazon.transcribe
      responses:
        '200':
          description: Transcription completed (or streaming).
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '503':
          description: Transcription is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/audio/translations:
    post:
      tags:
      - Audio
      - OpenAI
      summary: Transcribe and translate audio to English text (OpenAI format)
      description: 'Transcribes audio from any supported language and translates the
        result into English (OpenAI Audio Translations API).


        **Output is always English** — regardless of the source language. If you want
        the transcription in the original language, use `openai_audio_transcription`
        instead.


        **Providing the audio file:** Two request formats are accepted:

        - `multipart/form-data`: standard binary file upload via the `file` field.

        - `application/json`: pass `file` as a base64 string, data URI (`data:audio/<fmt>;base64,<data>`),
        HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot
        construct multipart requests.


        **MCP / AI agent usage:** Call this tool with a JSON body containing the audio
        as a data URI or URL, along with `model`. Example: `{"file": "data:audio/mp3;base64,<data>",
        "model": "amazon.transcribe"}`.


        **Find compatible models:** Call `search_models` with `route=openai_audio_translation`
        to discover model IDs that support speech-to-text translation.'
      operationId: openai_audio_translation
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_audio_translation'
            examples:
              json:
                summary: JSON response
                value:
                  model: amazon.transcribe
                  response_format: json
              srt:
                summary: Subtitle (SRT)
                value:
                  response_format: srt
          application/json:
            examples:
              data_uri:
                summary: Audio via data URI (MCP / AI agent)
                value:
                  file: data:audio/mp3;base64,<base64-encoded-audio>
                  model: amazon.transcribe
              url:
                summary: Audio from URL
                value:
                  file: https://example.com/audio.mp3
                  model: amazon.transcribe
      responses:
        '200':
          description: Translation completed.
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '503':
          description: Translation is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/batches:
    post:
      tags:
      - Batches
      - OpenAI
      summary: Create a batch of requests to run asynchronously (OpenAI format)
      description: 'Creates a batch that runs every request of an uploaded file asynchronously,
        at the discounted batch price (OpenAI Batch API).


        Upload the requests first with `openai_file` and `purpose=''batch''`: one
        JSON object per line, each with a unique `custom_id`, `method` `POST`, `url`
        equal to `endpoint`, and `body` holding the request itself. Every line must
        name the same model. A file breaking one of those rules is refused by this
        call, naming the line, and no batch is created.


        A batch must carry at least 100 requests. Tool use, structured outputs (`response_format`
        of type `json_schema`), streaming and `n` above 1 are not available in a batch;
        an embeddings request carries one `input` and returns its vector as numbers.


        **Find compatible models:** call `search_models` with `route=openai_chat_completion&batch=true`,
        or `route=openai_embedding&batch=true` for embeddings. That list is best effort:
        a model missing from it is still submitted, and only the backend decides.


        Returns the `Batch` immediately. Poll `openai_batch_get` until its `status`
        is `completed`, then download `output_file_id` with `openai_file_content`.
        Results may come back in any order — match them to the requests by `custom_id`.


        Set `output_expires_after` to have the result files deleted automatically
        once they are no longer needed.'
      operationId: openai_batch
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateParams'
      responses:
        '200':
          description: Batch created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Batch'
        '400':
          description: Invalid request or unsupported parameters.
        '503':
          description: The Batch API is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Batches
      - OpenAI
      summary: List batches (OpenAI format)
      description: Returns a paginated list of batches, newest first (OpenAI Batch
        API).
      operationId: openai_batch_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^batch_[a-z0-9]{32}$
          - type: 'null'
          description: 'Cursor for pagination: the batch ID to start after (the last
            ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the batch ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: A limit on the number of objects returned.
          default: 20
          title: Limit
        description: A limit on the number of objects returned.
      responses:
        '200':
          description: A paginated list of Batch objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/batches/{batch_id}:
    get:
      tags:
      - Batches
      - OpenAI
      summary: Retrieve a batch (OpenAI format)
      description: Returns the current state of a batch (OpenAI Batch API). Poll this
        endpoint until `status` is `completed`, then download `output_file_id` with
        `openai_file_content`; requests that failed are collected in `error_file_id`.
      operationId: openai_batch_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^batch_[a-z0-9]{32}$
          description: The identifier of the batch.
          title: Batch Id
        description: The identifier of the batch.
      responses:
        '200':
          description: The batch state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Batch'
        '404':
          description: Batch not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/batches/{batch_id}/cancel:
    post:
      tags:
      - Batches
      - OpenAI
      summary: Cancel a batch (OpenAI format)
      description: Cancels a batch that is still running (OpenAI Batch API). The batch
        moves to `cancelling` and then to `cancelled`; requests that already produced
        an answer keep it and stay readable in `output_file_id`. Cancelling a batch
        that has already ended changes nothing.
      operationId: openai_batch_cancel
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^batch_[a-z0-9]{32}$
          description: The identifier of the batch.
          title: Batch Id
        description: The identifier of the batch.
      responses:
        '200':
          description: Cancellation started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Batch'
        '404':
          description: Batch not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/chat/completions:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Generate a text response for a chat conversation (OpenAI format)
      description: 'Creates a model response for the given chat conversation (OpenAI
        Chat Completions API).


        Supports streaming, tool/function calling, and reasoning models. Returns a
        `ChatCompletion` object, or a stream of `ChatCompletionChunk` objects when
        `stream=true`.


        **Extended multimodal inputs (beyond original OpenAI API):**

        - **Text, images, and vision:** Pass images via URL, data URI, base64, or
        Files API `file_id` in the `content` array.

        - **Audio input:** Include audio content parts (`type: input_audio`) with
        `wav`/`mp3` data.

        - **File references:** Reference uploaded files directly via `type: file`
        with a `file_id` obtained from `openai_file`.

        - **Audio output:** Request spoken audio alongside text by setting `modalities:
        ["text", "audio"]` and an `audio` config with the desired voice and format.


        **When to use:** Prefer this endpoint for OpenAI SDK compatibility or when
        using the `messages` array format. For the newer stateless Responses API,
        use `openai_response` instead. For Anthropic SDK compatibility, use `anthropic_message`.


        **Find compatible models:** Call `search_models` with `route=openai_chat_completion`
        to discover model IDs that support this endpoint. When using extended multimodal
        inputs, also filter by the required modality — for example, add `input_modalities=IMAGE`
        for vision requests or `input_modalities=SPEECH` for audio input, so only
        models that support both the route and the modality are returned.'
      operationId: openai_chat_completion
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stdapi__types__openai_chat_completions__CompletionCreateParams'
            examples:
              basic:
                summary: Basic chat completion
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Hello, how are you?
              streaming:
                summary: Streaming response
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: user
                    content: Tell me a story
                  stream: true
              with_params:
                summary: With parameters
                value:
                  model: amazon.nova-micro-v1:0
                  messages:
                  - role: system
                    content: You are a helpful assistant.
                  - role: user
                    content: Explain quantum computing
                  temperature: 0.7
                  max_tokens: 1000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletion'
              example:
                id: chatcmpl-f6ed35b89b77488f8c481eb0a26ac1bf
                choices:
                - finish_reason: stop
                  index: 0
                  message:
                    content: I'm an AI assistant.
                    role: assistant
                created: 1740134957
                model: amazon.nova-micro-v1:0
                object: chat.completion
                usage:
                  completion_tokens: 16
                  prompt_tokens: 11
                  total_tokens: 27
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Chat
      - OpenAI
      summary: List stored chat completions (OpenAI format)
      description: 'Returns the chat completions persisted with `store=true`, sorted
        by creation time (OpenAI Chat Completions API).


        Filter by `model` and by metadata, passed either as a JSON object in the `metadata`
        query parameter (`metadata={"key": "value"}`) or as one `metadata[key]=value`
        query parameter per key. Listings cover the most recent 1,000 stored chat
        completions; older ones may not appear.'
      operationId: openai_chat_completion_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^chatcmpl-[A-Za-z0-9-]+$
          - type: 'null'
          description: 'Cursor for pagination: the chat completion ID to start after
            (the last ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the chat completion ID to start after
          (the last ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: A limit on the number of objects returned.
          default: 20
          title: Limit
        description: A limit on the number of objects returned.
      - name: model
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only return chat completions generated by this model.
          title: Model
        description: Only return chat completions generated by this model.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by creation time.
          default: asc
          title: Order
        description: Sort order by creation time.
      - name: metadata
        in: query
        required: false
        schema:
          type: string
        example: '{"project": "alpha"}'
        description: 'Filter by metadata key-value pairs, as a JSON object of string
          values (`{"project": "alpha"}`). The equivalent `metadata[key]=value` parameters
          are also accepted.'
      responses:
        '200':
          description: The stored chat completions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionList'
        '400':
          description: Invalid metadata filter.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/chat/completions/{completion_id}:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Update a stored chat completion (OpenAI format)
      description: Replaces the metadata of a chat completion previously persisted
        with `store=true` (OpenAI Chat Completions API). Metadata is the only updatable
        field; `null` clears it.
      operationId: openai_chat_completion_update
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: completion_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^chatcmpl-[A-Za-z0-9-]+$
          description: The ID of the stored chat completion.
          title: Completion Id
        description: The ID of the stored chat completion.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatCompletionUpdateParams'
      responses:
        '200':
          description: The updated chat completion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletion'
        '404':
          description: Chat completion not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Chat
      - OpenAI
      summary: Retrieve a stored chat completion (OpenAI format)
      description: Returns a chat completion previously persisted with `store=true`
        (OpenAI Chat Completions API).
      operationId: openai_chat_completion_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: completion_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^chatcmpl-[A-Za-z0-9-]+$
          description: The ID of the stored chat completion.
          title: Completion Id
        description: The ID of the stored chat completion.
      responses:
        '200':
          description: The stored chat completion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletion'
        '404':
          description: Chat completion not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Chat
      - OpenAI
      summary: Delete a stored chat completion (OpenAI format)
      description: Deletes a chat completion previously persisted with `store=true`,
        along with its stored messages (OpenAI Chat Completions API).
      operationId: openai_chat_completion_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: completion_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^chatcmpl-[A-Za-z0-9-]+$
          description: The ID of the stored chat completion.
          title: Completion Id
        description: The ID of the stored chat completion.
      responses:
        '200':
          description: Chat completion deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionDeleted'
        '404':
          description: Chat completion not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/chat/completions/{completion_id}/messages:
    get:
      tags:
      - Chat
      - OpenAI
      summary: List the input messages of a stored chat completion (OpenAI format)
      description: Returns the input messages of a chat completion previously persisted
        with `store=true` (OpenAI Chat Completions API).
      operationId: openai_chat_completion_messages
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: completion_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^chatcmpl-[A-Za-z0-9-]+$
          description: The ID of the stored chat completion.
          title: Completion Id
        description: The ID of the stored chat completion.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^msg-[0-9]+$
          - type: 'null'
          description: 'Cursor for pagination: the message ID to start after (the
            last ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the message ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: A limit on the number of objects returned.
          default: 20
          title: Limit
        description: A limit on the number of objects returned.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: 'Sort order: `asc` is conversation order.'
          default: asc
          title: Order
        description: 'Sort order: `asc` is conversation order.'
      responses:
        '200':
          description: The input messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionStoreMessageList'
        '404':
          description: Chat completion not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/completions:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Generate a text completion (OpenAI format)
      description: 'Creates a text completion (OpenAI Completions API). Returns a
        ``Completion`` object, or a stream of chunks terminated by ``data: [DONE]``
        when ``stream=true``.


        **Prompt shapes — how each ``prompt`` value is handled:**

        - ``"text"`` → one text completion (one choice).

        - ``["t1", "t2", …]`` → one choice per prompt (batch).

        - URL (``https://``, ``s3://``, ``data:``, ``file-id:<id>``) → the file is
        forwarded to the model using its detected modality (``image``, ``video``,
        ``audio``, ``document``); the model returns an error if it does not support
        that modality.

        - ``["instruction", <file>, <file>, …]`` (exactly one text + ≥1 files) → packed
        in input order into a single multimodal request, returning one choice. **This
        is the recommended shape for analysing files with an instruction** (e.g. describing
        an image, summarising a PDF).

        - ``[<file>, <file>, …]`` (files only, no text) → one choice per file, each
        forwarded as its detected modality.


        **Streaming:** text deltas arrive as SSE chunks carrying ``choices[0].index``
        so clients can attribute each delta to its prompt or choice; the terminal
        chunk per choice has ``finish_reason`` set.'
      operationId: openai_completion
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/stdapi__types__openai_completions__CompletionCreateParams'
            examples:
              basic:
                summary: Basic completion
                value:
                  model: amazon.nova-micro-v1:0
                  prompt: Hello, how are you?
                  max_tokens: 20
              streaming:
                summary: Streaming response
                value:
                  model: amazon.nova-micro-v1:0
                  prompt: Tell me a short story
                  stream: true
              with_params:
                summary: With parameters
                value:
                  model: amazon.nova-micro-v1:0
                  prompt: Explain quantum computing
                  temperature: 0.7
                  top_p: 0.9
                  max_tokens: 200
                  stop:
                  - '


                    '
              batch:
                summary: Batch prompts
                value:
                  model: amazon.nova-micro-v1:0
                  prompt:
                  - One plus one is
                  - Two plus two is
                  max_tokens: 5
              file_id:
                summary: File reference
                value:
                  model: amazon.nova-micro-v1:0
                  prompt: file-id:file-abc123
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Completion'
              example:
                id: cmpl-6c6bfcd3b39e4d0f8c481eb0a26ac1bf
                choices:
                - finish_reason: stop
                  index: 0
                  text: The capital of France is Paris.
                created: 1740134957
                model: amazon.nova-micro-v1:0
                object: text_completion
                usage:
                  completion_tokens: 8
                  prompt_tokens: 6
                  total_tokens: 14
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/conversations:
    post:
      tags:
      - Conversations
      - OpenAI
      summary: Create a conversation (OpenAI format)
      description: 'Creates a conversation (OpenAI Conversations API).


        A conversation holds the items of a multi-turn exchange. Pass its ID as `conversation`
        in `openai_response` and every request and response item of that turn is appended
        to it, so the next turn only has to send the new message.'
      operationId: openai_conversation
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ConversationCreateParams'
              - type: 'null'
              title: Request
      responses:
        '200':
          description: The created conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__openai_conversations__Conversation'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/conversations/{conversation_id}:
    get:
      tags:
      - Conversations
      - OpenAI
      summary: Retrieve a conversation (OpenAI format)
      description: Returns a conversation by ID (OpenAI Conversations API).
      operationId: openai_conversation_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      responses:
        '200':
          description: The conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__openai_conversations__Conversation'
        '404':
          description: Conversation not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Conversations
      - OpenAI
      summary: Update a conversation's metadata (OpenAI format)
      description: Merges key-value pairs into a conversation's metadata (OpenAI Conversations
        API). Keys that are not sent keep their value; a key sent as null is removed.
      operationId: openai_conversation_update
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationUpdateParams'
      responses:
        '200':
          description: The updated conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__openai_conversations__Conversation'
        '404':
          description: Conversation not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Conversations
      - OpenAI
      summary: Delete a conversation (OpenAI format)
      description: Deletes a conversation and every item it holds (OpenAI Conversations
        API).
      operationId: openai_conversation_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      responses:
        '200':
          description: Deletion confirmation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationDeleted'
        '404':
          description: Conversation not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/conversations/{conversation_id}/items:
    post:
      tags:
      - Conversations
      - OpenAI
      summary: Add items to a conversation (OpenAI format)
      description: Appends items to a conversation and returns them as a `list` page,
        in the order they were sent (OpenAI Conversations API). Item IDs are assigned
        by the server. An `item_reference` naming an item the conversation already
        holds is refused with `item_already_in_conversation`; send the item itself
        to add one. An item that configures a request rather than recording history,
        such as `compaction_trigger`, is accepted and left out of the conversation.
      operationId: openai_conversation_items
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      - name: include
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
              type: string
          - type: 'null'
          description: Additional item fields to return. `reasoning.encrypted_content`
            returns the reasoning items' encrypted content; other values are accepted
            and ignored.
          title: Include
        description: Additional item fields to return. `reasoning.encrypted_content`
          returns the reasoning items' encrypted content; other values are accepted
          and ignored.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationItemsCreateParams'
      responses:
        '200':
          description: The items that were added, in the order they were sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationItemList'
        '404':
          description: Conversation not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Conversations
      - OpenAI
      summary: List a conversation's items (OpenAI format)
      description: Returns a page of a conversation's items (OpenAI Conversations
        API). Pass the page's `last_id` as `after` to read the next page.
      operationId: openai_conversation_items_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: 'Cursor for pagination: the item ID to start after (the last
            ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the item ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 0
          description: A limit on the number of items returned.
          default: 20
          title: Limit
        description: A limit on the number of items returned.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: 'Sort order: `asc` is conversation order.'
          default: desc
          title: Order
        description: 'Sort order: `asc` is conversation order.'
      - name: include
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
              type: string
          - type: 'null'
          description: Additional item fields to return. `reasoning.encrypted_content`
            returns the reasoning items' encrypted content; other values are accepted
            and ignored.
          title: Include
        description: Additional item fields to return. `reasoning.encrypted_content`
          returns the reasoning items' encrypted content; other values are accepted
          and ignored.
      responses:
        '200':
          description: A page of conversation items.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationItemList'
        '404':
          description: Conversation not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/conversations/{conversation_id}/items/{item_id}:
    get:
      tags:
      - Conversations
      - OpenAI
      summary: Retrieve one item of a conversation (OpenAI format)
      description: Returns a single item of a conversation (OpenAI Conversations API).
      operationId: openai_conversation_item_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the item in the conversation.
          title: Item Id
        description: The ID of the item in the conversation.
      - name: include
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
              type: string
          - type: 'null'
          description: Additional item fields to return. `reasoning.encrypted_content`
            returns the reasoning items' encrypted content; other values are accepted
            and ignored.
          title: Include
        description: Additional item fields to return. `reasoning.encrypted_content`
          returns the reasoning items' encrypted content; other values are accepted
          and ignored.
      responses:
        '200':
          description: The conversation item.
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ResponseInputMessageItem'
                - $ref: '#/components/schemas/ResponseOutputMessage'
                - $ref: '#/components/schemas/ResponseOutputMessageInput-Output'
                - $ref: '#/components/schemas/ResponseFileSearchToolCall'
                - $ref: '#/components/schemas/FileSearchCallInput'
                - $ref: '#/components/schemas/ResponseComputerToolCall'
                - $ref: '#/components/schemas/ComputerCallInput'
                - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem'
                - $ref: '#/components/schemas/ResponseFunctionWebSearch'
                - $ref: '#/components/schemas/WebSearchCallInput'
                - $ref: '#/components/schemas/ResponseFunctionToolCallItem'
                - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem'
                - $ref: '#/components/schemas/ResponseToolSearchCall'
                - $ref: '#/components/schemas/ToolSearchCallInput'
                - $ref: '#/components/schemas/ResponseToolSearchOutputItem'
                - $ref: '#/components/schemas/ToolSearchOutputInput'
                - $ref: '#/components/schemas/AdditionalTools'
                - $ref: '#/components/schemas/ResponseConfigurationUpdateItem'
                - $ref: '#/components/schemas/ResponseReasoningItem'
                - $ref: '#/components/schemas/ResponseReasoningItemInput'
                - $ref: '#/components/schemas/ResponseCompactionItem'
                - $ref: '#/components/schemas/ImageGenerationCall'
                - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall'
                - $ref: '#/components/schemas/CodeInterpreterCallInput'
                - $ref: '#/components/schemas/LocalShellCall'
                - $ref: '#/components/schemas/LocalShellCallOutput'
                - $ref: '#/components/schemas/ResponseFunctionShellToolCall'
                - $ref: '#/components/schemas/ShellCall'
                - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput'
                - $ref: '#/components/schemas/ResponseApplyPatchToolCall'
                - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput'
                - $ref: '#/components/schemas/McpListTools'
                - $ref: '#/components/schemas/McpApprovalRequest'
                - $ref: '#/components/schemas/McpApprovalResponseOutput'
                - $ref: '#/components/schemas/McpCall'
                - $ref: '#/components/schemas/ResponseCustomToolCallItem'
                - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem'
                - $ref: '#/components/schemas/Program'
                - $ref: '#/components/schemas/ProgramOutput'
                title: Response Openai Conversation Item Get
        '404':
          description: Conversation or item not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Conversations
      - OpenAI
      summary: Delete one item of a conversation (OpenAI format)
      description: Removes one item from a conversation and returns the conversation
        (OpenAI Conversations API).
      operationId: openai_conversation_item_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the conversation.
          title: Conversation Id
        description: The ID of the conversation.
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 255
          description: The ID of the item in the conversation.
          title: Item Id
        description: The ID of the item in the conversation.
      responses:
        '200':
          description: The conversation the item was removed from.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stdapi__types__openai_conversations__Conversation'
        '404':
          description: Conversation or item not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/embeddings:
    post:
      tags:
      - Embeddings
      - OpenAI
      summary: Generate text embeddings as numeric vectors (OpenAI format)
      description: 'Creates embedding vector(s) for the input text (OpenAI Embeddings
        API).


        Accepts a single string or an array of strings for batch processing. Returns
        fixed-dimensional float vectors (or base64-encoded when `encoding_format=base64`)
        suitable for semantic search, clustering, and retrieval-augmented generation.


        **Extended input support (beyond original OpenAI API):**

        - **Multimodal inputs:** For models that support it, pass URLs, S3 URIs, or
        data URIs instead of plain strings to embed images or other media.


        **Find compatible models:** Call `search_models` with `route=openai_embedding`
        to discover model IDs that support embeddings. For multimodal inputs (URLs,
        S3 URIs), also add `input_modalities=IMAGE` to find models that accept both
        the embedding route and image input.'
      operationId: openai_embedding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingCreateParams'
            examples:
              single:
                summary: Single input
                value:
                  model: amazon.titan-embed-text-v2:0
                  input: Hello world
              batch:
                summary: Batch input
                value:
                  model: amazon.titan-embed-text-v2:0
                  input:
                  - first
                  - second
        required: true
      responses:
        '200':
          description: Embeddings successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmbeddingResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/files:
    post:
      tags:
      - Files
      - OpenAI
      summary: Upload a file for use in other API endpoints (OpenAI format)
      description: 'Uploads a file and returns a `FileObject` with the assigned file
        ID (OpenAI Files API).


        The returned `file_id` (format: `file-<32 hex chars>`) can be referenced in
        other tools such as `openai_image_edit` and `openai_image_variation` to supply
        images without re-uploading.


        **Providing the file:** Two request formats are accepted:

        - `multipart/form-data`: standard binary file upload via the `file` field.

        - `application/json`: pass `file` as a base64 string, data URI (`data:<mime>;base64,<data>`),
        HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot
        construct multipart requests.


        **MCP / AI agent usage:** Call this tool with a JSON body. To upload inline
        content use a data URI: `{"file": "data:text/plain;base64,SGVsbG8h", "purpose":
        "user_data"}`. To ingest a remote file pass its URL: `{"file": "https://example.com/document.pdf",
        "purpose": "assistants"}`.


        **File expiry:** Files with `purpose=batch` expire after 30 days by default.
        All other files persist until manually deleted. Use `expires_after[seconds]`
        (1 hour-30 days) to set a custom TTL.


        For files larger than a few MB, prefer the multipart upload workflow: create
        a session with `openai_upload`, add parts with `openai_upload_part`, then
        finalise with `openai_upload_complete`.'
      operationId: openai_file
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_file'
            examples:
              assistants:
                summary: Upload for Assistants API
                value:
                  purpose: assistants
              batch:
                summary: Upload for Batch API (expires after 30 days)
                value:
                  purpose: batch
              fine-tune:
                summary: Upload for fine-tuning
                value:
                  purpose: fine-tune
          application/json:
            examples:
              data_uri:
                summary: Inline content via data URI (MCP / AI agent)
                value:
                  file: data:text/plain;base64,SGVsbG8gV29ybGQ=
                  purpose: user_data
              url:
                summary: Fetch from URL
                value:
                  file: https://example.com/document.pdf
                  purpose: assistants
              base64:
                summary: Raw base64
                value:
                  file: SGVsbG8gV29ybGQ=
                  purpose: user_data
      responses:
        '200':
          description: The uploaded File object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileObject'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Files
      - OpenAI
      summary: List uploaded files (OpenAI format)
      description: Returns a paginated list of uploaded files, optionally filtered
        by purpose (OpenAI Files API).
      operationId: openai_file_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: purpose
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only return files with the given purpose.
          title: Purpose
        description: Only return files with the given purpose.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^file[-_][a-z0-9]{32}$
          - type: 'null'
          description: 'Cursor for pagination: the object ID to start after (the last
            ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the object ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          description: A limit on the number of objects to be returned.
          default: 10000
          title: Limit
        description: A limit on the number of objects to be returned.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by the `created_at` timestamp of the objects.
          default: desc
          title: Order
        description: Sort order by the `created_at` timestamp of the objects.
      responses:
        '200':
          description: A list of File objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFilesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/files/{file_id}:
    get:
      tags:
      - Files
      - OpenAI
      summary: Retrieve metadata for an uploaded file (OpenAI format)
      description: Returns metadata (name, size, purpose, creation time) for a specific
        file by ID (OpenAI Files API).
      operationId: openai_files_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: The ID of the file to use for this request.
          title: File Id
        description: The ID of the file to use for this request.
      responses:
        '200':
          description: The File object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileObject'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Files
      - OpenAI
      summary: Delete an uploaded file (OpenAI format)
      description: Permanently deletes a file by ID and returns a deletion confirmation
        (OpenAI Files API).
      operationId: openai_files_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: The ID of the file to use for this request.
          title: File Id
        description: The ID of the file to use for this request.
      responses:
        '200':
          description: Deletion status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDeleted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/files/{file_id}/content:
    get:
      tags:
      - Files
      - OpenAI
      summary: Download the raw content of an uploaded file (OpenAI format)
      description: 'Returns the raw binary content of a file as a streaming download
        (OpenAI Files API).


        **MCP / AI agent usage:** text files come back as text and images as an image;
        any other content, and anything too large to carry, comes back as a JSON reference
        holding the URL to download it from.'
      operationId: openai_file_content
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          description: The ID of the file to use for this request.
          title: File Id
        description: The ID of the file to use for this request.
      responses:
        '200':
          description: The raw file content.
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/images/edits:
    post:
      tags:
      - Images
      - OpenAI
      summary: Edit or extend an image using inpainting (OpenAI format)
      description: 'Edits or extends an image based on a text prompt and optional
        mask (OpenAI Images Edits API).


        Accepts one or more source images with an optional mask for inpainting, then
        generates an edited version. Supports streaming via SSE for incremental partial-image
        previews.


        **Providing images:** Use `multipart/form-data` for direct binary uploads,
        or `application/json` to reference images by Files API ID (obtained from `openai_file`)
        or by URL/data URL.


        **Find compatible models:** Call `search_models` with `route=openai_image_edit`
        to discover model IDs that support image editing.'
      operationId: openai_image_edit
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_image_edit'
            examples:
              inpaint:
                summary: Inpaint with mask
                value:
                  model: amazon.nova-canvas-v1:0
                  prompt: A red apple on a wooden table
                  response_format: url
                  n: 1
                  size: 1024x1024
              stream:
                summary: Streaming response
                value:
                  model: amazon.nova-canvas-v1:0
                  prompt: A sunset over mountains
                  stream: true
          application/json:
            examples:
              file_id:
                summary: Edit image by Files API ID
                value:
                  model: amazon.nova-canvas-v1:0
                  prompt: A red apple on a wooden table
                  images:
                  - file_id: file-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                  response_format: url
                  n: 1
                  size: 1024x1024
              image_url:
                summary: Edit image by URL
                value:
                  model: amazon.nova-canvas-v1:0
                  prompt: A sunset over mountains
                  images:
                  - image_url: https://example.com/image.png
                  stream: true
      responses:
        '200':
          description: Images successfully edited.
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported parameters.
        '503':
          description: The 'url' response format is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/images/generations:
    post:
      tags:
      - Images
      - OpenAI
      summary: Generate images from a text prompt (OpenAI format)
      description: 'Creates one or more images from a text prompt (OpenAI Images Generations
        API).


        Returns image URLs or base64-encoded data (`b64_json`). Supports streaming
        via SSE for incremental partial-image previews while generation is in progress
        (`stream=true`). Multiple images can be requested with the `n` parameter.


        **Find compatible models:** Call `search_models` with `route=openai_image_generation`
        to discover model IDs that support image generation.'
      operationId: openai_image_generation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageGenerateParams'
            examples:
              url:
                summary: Return image URL
                value:
                  prompt: A watercolor of a fox in the woods
                  model: amazon.nova-canvas-v1:0
                  response_format: url
              b64:
                summary: Return base64 data
                value:
                  prompt: A watercolor of a fox in the woods
                  model: amazon.nova-canvas-v1:0
                  response_format: b64_json
              stream:
                summary: Streaming SSE
                value:
                  prompt: A watercolor of a fox in the woods
                  model: amazon.nova-canvas-v1:0
                  stream: true
        required: true
      responses:
        '200':
          description: Images successfully generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagesResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '503':
          description: The 'url' response format is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/images/variations:
    post:
      tags:
      - Images
      - OpenAI
      summary: Create variations of an existing image (OpenAI format)
      description: 'Creates one or more stylistic variations of a given image (OpenAI
        Images Variations API).


        **Providing the source image:** Use `multipart/form-data` for a direct binary
        upload, or `application/json` body to reference the image by Files API ID
        (obtained from `openai_file`) or by URL/data URL.


        Returns image URLs or base64-encoded data. Multiple variations can be requested
        with `n`. **Note:** Streaming is not supported for this endpoint — use `openai_image_generation`
        or `openai_image_edit` if you need streaming with partial previews.


        **Find compatible models:** Call `search_models` with `route=openai_image_variation`
        to discover model IDs that support image variation.'
      operationId: openai_image_variation
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_image_variation'
            examples:
              url:
                summary: Return image URL
                value:
                  model: amazon.nova-canvas-v1:0
                  response_format: url
                  n: 1
                  size: 1024x1024
              b64:
                summary: Return base64 data
                value:
                  model: amazon.nova-canvas-v1:0
                  response_format: b64_json
                  n: 2
                  size: 512x512
          application/json:
            examples:
              file_id:
                summary: Variation from Files API ID
                value:
                  model: amazon.nova-canvas-v1:0
                  image:
                    file_id: file-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                  response_format: url
                  n: 1
                  size: 1024x1024
              image_url:
                summary: Variation from URL
                value:
                  model: amazon.nova-canvas-v1:0
                  image:
                    image_url: https://example.com/image.png
                  response_format: b64_json
                  n: 2
                  size: 512x512
      responses:
        '200':
          description: Image variations successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagesResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '503':
          description: The 'url' response format is not enabled on this server.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/models:
    get:
      tags:
      - Models
      - OpenAI
      summary: List available models (OpenAI format)
      description: 'Lists all currently available models with basic metadata (owner,
        creation date) (OpenAI Models API).


        **Agent note:** For richer filtering — by modality, route, MCP tool, region,
        or legacy status — use `search_models` instead.'
      operationId: openai_model_list
      responses:
        '200':
          description: List of available models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelsResponse'
              examples:
                list:
                  summary: Example list
                  value:
                    object: list
                    data:
                    - id: amazon.nova-micro-v1:0
                      object: model
                      created: 1640995200
                      owned_by: Amazon
                    - id: anthropic.claude-sonnet-4-5-20250929-v1:0
                      object: model
                      created: 1640995200
                      owned_by: Anthropic
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/models/{model}:
    get:
      tags:
      - Models
      - OpenAI
      summary: Retrieve details for a specific model by ID (OpenAI format)
      description: 'Retrieves basic metadata (owner, creation date) for a single model
        by ID (OpenAI Models API).


        **Agent note:** Use `search_models` to look up modalities, supported routes,
        regions, and other extended metadata not available here.'
      operationId: openai_model_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: model
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
          description: The ID of the model to use for this request
          examples:
          - amazon.nova-micro-v1:0
          title: Model
        description: The ID of the model to use for this request
      responses:
        '200':
          description: Model retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
              examples:
                model:
                  summary: Example model
                  value:
                    id: amazon.nova-micro-v1:0
                    object: model
                    created: 1640995200
                    owned_by: Amazon
        '404':
          description: Model not found
          content:
            application/json:
              examples:
                not_found:
                  summary: Model not found
                  value:
                    error:
                      message: The model `unknown` does not exist or you do not have
                        access to it.
                      type: invalid_request_error
                      code: model_not_found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/moderations:
    post:
      tags:
      - Moderations
      - OpenAI
      summary: Classify text and images for content moderation (OpenAI format)
      description: 'Classifies inputs with a content moderation model (OpenAI Moderations
        API).


        Each input element is evaluated independently and yields one result, with
        the model''s findings mapped to the OpenAI moderation categories.


        **Available models:**

        - **`amazon.bedrock-runtime-guardrail`** (the server''s default guardrail,
        or an explicit `<guardrail-id>`, `<guardrail-id>:<version>`, or guardrail
        ARN) — text and image inputs. Content filters map to the OpenAI categories
        (`HATE`→`hate`, `INSULTS`→`harassment`, `SEXUAL`→`sexual`, `VIOLENCE`→`violence`,
        `MISCONDUCT`→`illicit`); other guardrail policies (denied topics, word filters,
        sensitive information) surface through the overall `flagged` field.

        - **`amazon.bedrock-runtime-guardrail-checks`** (inline guardrail checks)
        — text inputs only, no guardrail resource needed. Content filter checks map
        to the same OpenAI categories, with severity scores (`0.0` to `1.0`) reported
        directly; when the server enables them, prompt attack (jailbreak, prompt injection,
        prompt leakage) and personal data detection surface through the overall `flagged`
        field, which has no OpenAI category. Available only in the regions this server
        is configured for that support it.

        - **`amazon.comprehend-toxicity`** (toxicity detection) — English text only,
        no images. `flagged` can be true even with every category `false` and every
        score `0.0`: it also reflects the overall toxicity score and unmapped labels
        such as profanity.


        Omit `model` to use the server''s default moderation model. OpenAI moderation
        model names are accepted as aliases: `omni-moderation-*` for the default guardrail
        (falling back to guardrail checks, then toxicity detection, when none is configured)
        and `text-moderation-*` for toxicity detection.


        **MCP / AI agent usage:** image inputs accept a base64 string, data URI, HTTPS
        URL, or S3 URI in `image_url.url`.'
      operationId: openai_moderation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModerationCreateParams'
            examples:
              text:
                summary: Classify a text
                value:
                  input: Some text to classify
              image:
                summary: Classify a text and an image
                value:
                  input:
                  - type: text
                    text: Describe this image
                  - type: image_url
                    image_url:
                      url: https://example.com/photo.png
        required: true
      responses:
        '200':
          description: Moderation results, one per input element.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModerationCreateResponse'
        '400':
          description: Invalid input, disallowed model selection, or image input not
            supported by the selected model.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/organization/usage/completions:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report chat, responses and completions usage (OpenAI format)
      description: 'Reports the tokens consumed by chat, responses, text completion
        and realtime requests, in time buckets (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_completions
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: batch
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: 'UNSUPPORTED: Batch API usage is not reported by this endpoint;
            its spend appears in `/v1/organization/costs`.'
          title: Batch
        description: 'UNSUPPORTED: Batch API usage is not reported by this endpoint;
          its spend appears in `/v1/organization/costs`.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/embeddings:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report embeddings usage (OpenAI format)
      description: 'Reports the tokens consumed by embeddings requests, in time buckets
        (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_embeddings
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/moderations:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report moderations usage (OpenAI format)
      description: 'Reports the tokens consumed by moderation requests, in time buckets
        (OpenAI Usage API). A moderation served without a language model counts as
        a request and reports no tokens.


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_moderations
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/images:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report image generation usage (OpenAI format)
      description: 'Reports the images produced by generation, edit and variation
        requests, in time buckets (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_images
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: sources
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - image.generation
              - image.edit
              - image.variation
              type: string
          - type: 'null'
          description: Report only images produced by these request kinds.
          title: Sources
        description: Report only images produced by these request kinds.
      - name: sizes
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: image size is not reported.'
          title: Sizes
        description: 'UNSUPPORTED: image size is not reported.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/audio_speeches:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report speech synthesis usage (OpenAI format)
      description: 'Reports the characters synthesized by speech requests, in time
        buckets (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_audio_speeches
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/audio_transcriptions:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report transcription usage (OpenAI format)
      description: 'Reports the seconds of audio transcribed or translated, in time
        buckets (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_audio_transcriptions
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/web_search_calls:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report web search usage (OpenAI format)
      description: 'Reports the web searches run by the built-in search tool, in time
        buckets (OpenAI Usage API).


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_web_search_calls
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: models
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these models.
          title: Models
        description: Report only usage of these models.
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: context_levels
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: search context size is not reported.'
          title: Context Levels
        description: 'UNSUPPORTED: search context size is not reported.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/file_search_calls:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report file search usage (OpenAI format)
      description: 'Reports the vector store searches run, in time buckets (OpenAI
        Usage API). Searches are counted for the deployment as a whole, never per
        vector store.


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_file_search_calls
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: user_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these users.
          title: User Ids
        description: Report only usage of these users.
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: vector_store_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: searches are not reported per vector store.'
          title: Vector Store Ids
        description: 'UNSUPPORTED: searches are not reported per vector store.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/vector_stores:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report vector store storage (OpenAI format)
      description: 'Reports vector store storage in time buckets (OpenAI Usage API).
        This server takes no storage measurement, so the buckets carry no results.


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_vector_stores
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of empty time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/usage/code_interpreter_sessions:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report code interpreter sessions (OpenAI format)
      description: 'Reports code interpreter sessions in time buckets (OpenAI Usage
        API). A model that runs code runs it inside the turn rather than in a session
        of its own, so there is nothing to count and the buckets carry no results.


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_usage_code_interpreter_sessions
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          enum:
          - 1m
          - 1h
          - 1d
          type: string
          description: 'Width of each time bucket. Narrow widths are only available
            for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455
            days.'
          default: 1d
          title: Bucket Width
        description: 'Width of each time bucket. Narrow widths are only available
          for recent ranges: 1m for the last 15 days, 1h and 1d for the last 455 days.'
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1440
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
            and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
          title: Limit
        description: Number of buckets to return. Defaults to 7 for 1d, 24 for 1h
          and 60 for 1m; the maximum is 31, 168 and 1440 respectively.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of empty time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organization/costs:
    get:
      tags:
      - Organization Usage
      - OpenAI
      summary: Report costs (OpenAI format)
      description: 'Reports what serving the requests cost, in daily buckets (OpenAI
        Costs API). The amount is what the underlying cloud provider bills this deployment
        for the work, not what any reseller charges its own clients.


        Administrator endpoint: it reports the whole deployment, not the calling client.'
      operationId: openai_organization_costs
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: start_time
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
          description: Start of the reported range, in Unix seconds, inclusive.
          title: Start Time
        description: Start of the reported range, in Unix seconds, inclusive.
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
          - type: 'null'
          description: End of the reported range, in Unix seconds, exclusive. Defaults
            to now.
          title: End Time
        description: End of the reported range, in Unix seconds, exclusive. Defaults
          to now.
      - name: bucket_width
        in: query
        required: false
        schema:
          const: 1d
          type: string
          description: Width of each time bucket.
          default: 1d
          title: Bucket Width
        description: Width of each time bucket.
      - name: group_by
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'Keys to group the reported usage by: ''model'' everywhere,
            ''source'' on images, plus ''api_key_id'' and ''user_id'' where the server
            records them. Any other key upstream declares is refused with the reason
            it cannot be answered.'
          title: Group By
        description: 'Keys to group the reported usage by: ''model'' everywhere, ''source''
          on images, plus ''api_key_id'' and ''user_id'' where the server records
          them. Any other key upstream declares is refused with the reason it cannot
          be answered.'
      - name: api_key_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Report only usage of these API keys.
          title: Api Key Ids
        description: Report only usage of these API keys.
      - name: project_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: 'UNSUPPORTED: this server has no projects.'
          title: Project Ids
        description: 'UNSUPPORTED: this server has no projects.'
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 180
            minimum: 1
          - type: 'null'
          description: Number of buckets to return. Defaults to 7.
          title: Limit
        description: Number of buckets to return. Defaults to 7.
      - name: page
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor from the `next_page` field of a previous response.
          title: Page
        description: Cursor from the `next_page` field of a previous response.
      responses:
        '200':
          description: A page of daily time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/realtime/client_secrets:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: Mint an ephemeral client secret for a realtime session (OpenAI format)
      description: 'Creates a short-lived client secret carrying a session configuration
        (OpenAI Realtime Client Secrets API).


        Hand the returned `value` to an untrusted client -- a browser or a mobile
        application -- so it can open a realtime WebSocket without ever holding this
        deployment''s API key. The secret carries the session configuration given
        here and applies it to every session opened with it, until it expires.


        Connect with it to `wss://<host>/v1/realtime?model=<model>`, sending it as
        the `Authorization: Bearer` header.


        **Find compatible models:** Call `search_models` with `route=openai_realtime`
        to discover model IDs that support live speech-to-speech sessions.'
      operationId: openai_realtime_client_secret
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ClientSecretCreateParams'
              - type: 'null'
              title: Request
      responses:
        '200':
          description: Client secret created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientSecretCreateResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/realtime/calls:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: Open a WebRTC realtime call with an SDP offer (OpenAI format)
      description: 'Trades a WebRTC SDP offer for an SDP answer, opening a live speech-to-speech
        call terminated by this server (OpenAI Realtime Calls API).


        Send the offer as a raw `application/sdp` body -- with an ephemeral client
        secret or the deployment''s credentials -- or as `multipart/form-data` with
        an `sdp` field and an optional `session` JSON field. Audio then flows as Opus
        media tracks and session events ride an `oai-events` data channel, in the
        same vocabulary as the WebSocket transport. The call''s identifier is returned
        in the `Location` header; end the call with `POST /v1/realtime/calls/{call_id}/hangup`.


        **Find compatible models:** Call `search_models` with `route=openai_realtime`.'
      operationId: openai_realtime_call_create
      parameters:
      - name: model
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Model answering the call; the session configuration may name
            it instead.
          title: Model
        description: Model answering the call; the session configuration may name
          it instead.
      responses:
        '201':
          description: Call created; the body is the SDP answer.
          content:
            application/json:
              schema: {}
            text/plain:
              schema:
                type: string
        '400':
          description: Invalid offer, encoding or configuration.
        '404':
          description: WebRTC calls are not enabled.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/realtime/calls/{call_id}/hangup:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: End a WebRTC realtime call (OpenAI format)
      description: Ends an active WebRTC call opened by `POST /v1/realtime/calls`
        (OpenAI Realtime Calls API). The call's media path and model session are torn
        down.
      operationId: openai_realtime_call_hangup
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: call_id
        in: path
        required: true
        schema:
          type: string
          description: Call identifier, from the creation's Location header.
          title: Call Id
        description: Call identifier, from the creation's Location header.
      responses:
        '200':
          description: Call ended.
          content:
            application/json:
              schema: {}
        '404':
          description: No such call.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/realtime/calls/{call_id}/accept:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: Accept an incoming SIP call (not available)
      description: 'Always refused: accepting an incoming SIP call requires a SIP
        trunk terminated by the server, which this deployment does not do. Use a SIP-capable
        media framework in front of the WebSocket transport.'
      operationId: openai_realtime_call_accept
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: call_id
        in: path
        required: true
        schema:
          type: string
          description: Call identifier.
          title: Call Id
        description: Call identifier.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: SIP calls are not available.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/realtime/calls/{call_id}/reject:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: Reject an incoming SIP call (not available)
      description: 'Always refused: rejecting an incoming SIP call requires a SIP
        trunk terminated by the server, which this deployment does not do. Use a SIP-capable
        media framework in front of the WebSocket transport.'
      operationId: openai_realtime_call_reject
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: call_id
        in: path
        required: true
        schema:
          type: string
          description: Call identifier.
          title: Call Id
        description: Call identifier.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: SIP calls are not available.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/realtime/calls/{call_id}/refer:
    post:
      tags:
      - Realtime
      - OpenAI
      summary: Transfer an incoming SIP call (not available)
      description: 'Always refused: transferring a SIP call requires a SIP trunk terminated
        by the server, which this deployment does not do. Use a SIP-capable media
        framework in front of the WebSocket transport.'
      operationId: openai_realtime_call_refer
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: call_id
        in: path
        required: true
        schema:
          type: string
          description: Call identifier.
          title: Call Id
        description: Call identifier.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: SIP calls are not available.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/responses:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Generate a model response using the Responses API (OpenAI format)
      description: 'Creates a model response (OpenAI Responses API).


        Supports streaming, tool calling, and structured outputs. Returns a `Response`
        object, or a stream of `ResponseStreamEvent` objects when `stream=true`.


        **Supported input modalities:**

        - **Text:** Plain strings or `input_text` content blocks.

        - **Images:** `input_image` content blocks with a URL, data URI, base64 image,
        or Files API `file_id` obtained from `openai_file`.

        - **Files:** `input_file` content blocks with a URL, base64 data, or Files
        API `file_id` obtained from `openai_file`.

        - **Audio input** is not supported — use `openai_chat_completion` for audio
        input.


        **When to use:** This is the newer OpenAI API style. For the classic `messages`-array
        format, use `openai_chat_completion` instead. For Anthropic SDK compatibility,
        use `anthropic_message`.


        **Find compatible models:** Call `search_models` with `route=openai_response`
        to discover model IDs that support this endpoint. For image inputs, also add
        `input_modalities=IMAGE` to the filter.'
      operationId: openai_response
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponseCreateParams'
        required: true
      responses:
        '200':
          description: A model response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/responses/input_tokens:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Count input tokens for a Responses request without generating a response
        (OpenAI format)
      description: 'Counts the number of tokens a given request would consume, without
        creating a response.


        Accepts the same input as `openai_response` (messages, instructions, tools,
        images, files) and returns only the token count. Useful for estimating costs
        or checking context-window fit before making a full `openai_response` call.


        Every text model is counted: exactly where the model''s own counter serves
        it, otherwise as an approximation that is never below the exact count on the
        content measured.


        **Find compatible models:** Call `search_models` with `route=openai_response_input_tokens`
        to discover model IDs that support this endpoint.'
      operationId: openai_response_input_tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputTokenCountParams'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InputTokenCountResponse'
              example:
                object: response.input_tokens
                input_tokens: 142
        '400':
          description: Invalid request or unsupported parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/responses/compact:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Compact a conversation into a reusable summary item (OpenAI format)
      description: 'Compacts a conversation into a single `compaction` output item
        (OpenAI Responses API).


        The model summarises the provided `input`; the summary is returned as an opaque
        `compaction` item. Include that item in the `input` of later `openai_response`
        calls to continue the conversation with a reduced context window.


        The compaction content is self-contained, so no conversation state is needed
        on the server; `previous_response_id` may reference a stored response to compact
        its conversation too.


        **Find compatible models:** Call `search_models` with `route=openai_response_compact`
        to discover model IDs that support this endpoint.'
      operationId: openai_response_compact
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompactParams'
        required: true
      responses:
        '200':
          description: The compacted response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompactedResponse'
        '400':
          description: Invalid request or unsupported parameters.
        '404':
          description: Model not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/responses/{response_id}:
    get:
      tags:
      - Chat
      - OpenAI
      summary: Retrieve a stored model response (OpenAI format)
      description: 'Returns a model response previously persisted with `store=true`
        (OpenAI Responses API).


        Pass the response ID as `previous_response_id` in `openai_response` to continue
        the conversation.'
      operationId: openai_response_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: response_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^resp[-_][A-Za-z0-9-]+$
          description: The ID of the stored response.
          title: Response Id
        description: The ID of the stored response.
      - name: stream
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Retrieving a response as a stream is not supported on this
            implementation.
          title: Stream
        description: Retrieving a response as a stream is not supported on this implementation.
      - name: include
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
              type: string
          - type: 'null'
          description: Accepted for compatibility and ignored.
          title: Include
        description: Accepted for compatibility and ignored.
      - name: starting_after
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Accepted for compatibility and ignored.
          title: Starting After
        description: Accepted for compatibility and ignored.
      responses:
        '200':
          description: The stored response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '404':
          description: Response not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Chat
      - OpenAI
      summary: Delete a stored model response (OpenAI format)
      description: Deletes a model response previously persisted with `store=true`,
        along with its stored conversation state (OpenAI Responses API).
      operationId: openai_response_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: response_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^resp[-_][A-Za-z0-9-]+$
          description: The ID of the stored response.
          title: Response Id
        description: The ID of the stored response.
      responses:
        '200':
          description: Response deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDeleted'
        '404':
          description: Response not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/responses/{response_id}/cancel:
    post:
      tags:
      - Chat
      - OpenAI
      summary: Cancel a background model response (OpenAI format)
      description: Cancels a model response (OpenAI Responses API). Only responses
        created with `background=true` can be cancelled; cancelling any other response
        fails with the OpenAI error for synchronous responses.
      operationId: openai_response_cancel
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: response_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^resp[-_][A-Za-z0-9-]+$
          description: The ID of the stored response.
          title: Response Id
        description: The ID of the stored response.
      responses:
        '200':
          description: The cancelled response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          description: The response is synchronous and cannot be cancelled.
        '404':
          description: Response not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/responses/{response_id}/input_items:
    get:
      tags:
      - Chat
      - OpenAI
      summary: List the input items of a stored model response (OpenAI format)
      description: Returns the input items that produced a stored model response (OpenAI
        Responses API).
      operationId: openai_response_input_items
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: response_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^resp[-_][A-Za-z0-9-]+$
          description: The ID of the stored response.
          title: Response Id
        description: The ID of the stored response.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: 'Cursor for pagination: the item ID to start after (the last
            ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the item ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: A limit on the number of objects returned.
          default: 20
          title: Limit
        description: A limit on the number of objects returned.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: 'Sort order: `asc` is conversation order.'
          default: desc
          title: Order
        description: 'Sort order: `asc` is conversation order.'
      - name: include
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
              type: string
          - type: 'null'
          description: Accepted for compatibility and ignored.
          title: Include
        description: Accepted for compatibility and ignored.
      responses:
        '200':
          description: The input items.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseItemList'
        '404':
          description: Response not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads:
    post:
      tags:
      - Files
      - OpenAI
      summary: Create a multipart upload session for large files (OpenAI format)
      description: 'Creates a multipart upload session for uploading large files in
        chunks (OpenAI Uploads API).


        **Multipart upload workflow:**

        1. Call `openai_upload` to create a session and get an `upload_id`.

        2. Upload file chunks with `openai_upload_part` (one call per chunk).

        3. Call `openai_upload_complete` with the ordered list of part IDs to assemble
        the final file.

        4. Optionally call `openai_upload_cancel` to abort a pending session.


        **File expiry:** Files with `purpose=batch` expire after 30 days by default.
        All other files persist until manually deleted. Use `expires_after.seconds`
        (1 hour-30 days) to set a custom TTL.


        For small files, use `openai_file` instead — it uploads in a single request.'
      operationId: openai_upload
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUploadBody'
        required: true
      responses:
        '200':
          description: The Upload object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v1/uploads/{upload_id}/parts:
    post:
      tags:
      - Files
      - OpenAI
      summary: Upload a chunk in a multipart upload session (OpenAI format)
      description: 'Adds a binary chunk (Part) to an existing multipart upload session
        (OpenAI Uploads API).


        **Prerequisite:** Create an upload session first with `openai_upload`. Call
        this endpoint once per chunk, then finalise with `openai_upload_complete`.


        **Part size:** a binary Part is streamed straight to storage and may carry
        up to 5 GiB, with at most 10,000 Parts per upload. Every Part but the last
        must also be at least 5 MiB. A Part sent inline as JSON is decoded in memory
        instead, so it carries at most 67108864 bytes (64 MiB). This is more permissive
        than the OpenAI API, which caps every Part at 64 MiB.


        **MCP / AI agent usage:** Pass the chunk as a JSON body with ``data`` set
        to a base64 string, data URI (``data:<mime>;base64,<data>``), HTTPS URL, or
        S3 URI.'
      operationId: openai_upload_part
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^upload_[a-z0-9]{32}$
          description: The ID of the upload.
          title: Upload Id
        description: The ID of the upload.
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_upload_part'
      responses:
        '200':
          description: The upload Part object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadPart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads/{upload_id}/complete:
    post:
      tags:
      - Files
      - OpenAI
      summary: Complete a multipart upload and create the final file (OpenAI format)
      description: 'Assembles all uploaded parts into a final `File` object and marks
        the session as completed (OpenAI Uploads API).


        **Prerequisite:** All parts must have been uploaded via `openai_upload_part`.
        Provide the ordered list of part IDs returned by those calls. The resulting
        file behaves like a file uploaded with `openai_file`.


        **Integrity:** pass `md5` to have the assembled file checked against the digest
        of the bytes you sent; a mismatch is refused and leaves no file behind.'
      operationId: openai_upload_complete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^upload_[a-z0-9]{32}$
          description: The ID of the upload.
          title: Upload Id
        description: The ID of the upload.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteUploadBody'
      responses:
        '200':
          description: The completed Upload object with a nested File object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads/{upload_id}/cancel:
    post:
      tags:
      - Files
      - OpenAI
      summary: Cancel a pending multipart upload session (OpenAI format)
      description: 'Cancels a pending multipart upload session; no further parts can
        be added (OpenAI Uploads API).


        **Prerequisite:** The session must have been created with `openai_upload`
        and not yet completed or cancelled.'
      operationId: openai_upload_cancel
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^upload_[a-z0-9]{32}$
          description: The ID of the upload.
          title: Upload Id
        description: The ID of the upload.
      responses:
        '200':
          description: The cancelled Upload object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores:
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Create a vector store for semantic file search (OpenAI format)
      description: 'Creates a vector store, an indexed collection of files that can
        be searched by meaning rather than by keyword (OpenAI Vector Stores API).


        Pass `file_ids` to index files already uploaded with `openai_file`. Indexing
        runs in the background: the store is returned immediately with `status=in_progress`
        and becomes `completed` once every file is indexed. Poll `openai_vector_store_get`,
        or `openai_vector_store_file_get` for one file.


        Only text files can be indexed; a file of any other type is refused with `400`,
        since its type says so before its bytes are read.'
      operationId: openai_vector_store_create
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorStoreCreateParams'
      responses:
        '200':
          description: The created vector store.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStore'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: List vector stores (OpenAI format)
      description: Returns a paginated list of vector stores (OpenAI Vector Stores
        API).
      operationId: openai_vector_store_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          - type: 'null'
          description: 'Cursor: the object ID to start after.'
          title: After
        description: 'Cursor: the object ID to start after.'
      - name: before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          - type: 'null'
          description: 'Cursor: the object ID to stop before.'
          title: Before
        description: 'Cursor: the object ID to stop before.'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of objects to return, from 1 to 100.
          default: 20
          title: Limit
        description: Number of objects to return, from 1 to 100.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by the `created_at` timestamp of the objects.
          default: desc
          title: Order
        description: Sort order by the `created_at` timestamp of the objects.
      responses:
        '200':
          description: A list of vector stores.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVectorStoresResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}:
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: Retrieve a vector store (OpenAI format)
      description: Returns a vector store, including its indexing progress in `file_counts`
        and its `status` (OpenAI Vector Stores API).
      operationId: openai_vector_store_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      responses:
        '200':
          description: The vector store.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStore'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Update a vector store (OpenAI format)
      description: Updates a vector store's `name`, `metadata` or expiration policy
        (OpenAI Vector Stores API). Send `expires_after` as `null` to remove the expiration.
      operationId: openai_vector_store_update
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorStoreUpdateParams'
      responses:
        '200':
          description: The updated vector store.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStore'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Vector Stores
      - OpenAI
      summary: Delete a vector store (OpenAI format)
      description: 'Permanently deletes a vector store and everything indexed in it
        (OpenAI Vector Stores API). The uploaded files themselves are kept.


        A store the server does not own is rejected: it is addressed, never created
        or deleted here.'
      operationId: openai_vector_store_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      responses:
        '200':
          description: Deletion status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreDeleted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/search:
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Search a vector store by meaning (OpenAI format)
      description: 'Returns the passages of the indexed files closest in meaning to
        the query (OpenAI Vector Stores API).


        Each result carries its source `file_id`, `filename`, the matching text and
        a `score`, best match first. Use `filters` to restrict the search to files
        carrying given `attributes`, and `ranking_options.score_threshold` to drop
        weak matches, on a store whose scores are comparable between searches.'
      operationId: openai_vector_store_search
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorStoreSearchParams'
      responses:
        '200':
          description: The search results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreSearchResultsPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/files:
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Attach a file to a vector store (OpenAI format)
      description: 'Indexes an already-uploaded file into a vector store (OpenAI Vector
        Stores API). Upload the file first with `openai_file`.


        Indexing runs in the background: the file is returned with `status=in_progress`
        and becomes `completed` once searchable. Use `openai_vector_store_file_batch_create`
        to attach several files at once.


        A file of a type the store cannot index is refused with `400` here, rather
        than attached and settled `failed` afterwards.'
      operationId: openai_vector_store_file_create
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorStoreFileCreateParams'
      responses:
        '200':
          description: The attached file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFile'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: List the files attached to a vector store (OpenAI format)
      description: Returns a paginated list of the files attached to a vector store,
        with their indexing status (OpenAI Vector Stores API).
      operationId: openai_vector_store_file_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          - type: 'null'
          description: 'Cursor: the object ID to start after.'
          title: After
        description: 'Cursor: the object ID to start after.'
      - name: before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          - type: 'null'
          description: 'Cursor: the object ID to stop before.'
          title: Before
        description: 'Cursor: the object ID to stop before.'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of objects to return, from 1 to 100.
          default: 20
          title: Limit
        description: Number of objects to return, from 1 to 100.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by the `created_at` timestamp of the objects.
          default: desc
          title: Order
        description: Sort order by the `created_at` timestamp of the objects.
      - name: filter
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - in_progress
            - completed
            - failed
            - cancelled
            type: string
          - type: 'null'
          description: Return only files with this status.
          title: Filter
        description: Return only files with this status.
      responses:
        '200':
          description: A list of vector store files.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVectorStoreFilesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/files/{file_id}:
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: Retrieve a file attached to a vector store (OpenAI format)
      description: Returns one attached file with its indexing `status` and, when
        it failed, `last_error` (OpenAI Vector Stores API).
      operationId: openai_vector_store_file_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          description: The ID of the attached file.
          title: File Id
        description: The ID of the attached file.
      responses:
        '200':
          description: The vector store file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFile'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Update the attributes of an attached file (OpenAI format)
      description: Replaces the `attributes` stored with an attached file (OpenAI
        Vector Stores API). The new attributes apply to later searches.
      operationId: openai_vector_store_file_update
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          description: The ID of the attached file.
          title: File Id
        description: The ID of the attached file.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VectorStoreFileUpdateParams'
      responses:
        '200':
          description: The updated vector store file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFile'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Vector Stores
      - OpenAI
      summary: Detach a file from a vector store (OpenAI format)
      description: Removes a file from a vector store so it is no longer searchable
        (OpenAI Vector Stores API). The uploaded file itself is kept.
      operationId: openai_vector_store_file_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          description: The ID of the attached file.
          title: File Id
        description: The ID of the attached file.
      responses:
        '200':
          description: Deletion status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFileDeleted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/files/{file_id}/content:
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: Read the indexed content of an attached file (OpenAI format)
      description: Returns the passages a file was indexed as, in document order (OpenAI
        Vector Stores API). Use `openai_file_content` to download the original file
        instead.
      operationId: openai_vector_store_file_content
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          description: The ID of the attached file.
          title: File Id
        description: The ID of the attached file.
      responses:
        '200':
          description: The indexed content of the file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContentPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/file_batches:
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Attach several files to a vector store at once (OpenAI format)
      description: 'Indexes several already-uploaded files into a vector store in
        one request (OpenAI Vector Stores API).


        Pass `file_ids` to share one set of `attributes` and one `chunking_strategy`
        across the batch, or `files` to give each file its own. Indexing runs in the
        background; poll `openai_vector_store_file_batch_get` until `status` is `completed`.'
      operationId: openai_vector_store_file_batch_create
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileBatchCreateParams'
      responses:
        '200':
          description: The created file batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFileBatch'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}:
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: Retrieve a file batch (OpenAI format)
      description: Returns a file batch with its indexing progress in `file_counts`
        (OpenAI Vector Stores API).
      operationId: openai_vector_store_file_batch_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^vsfb_[0-9a-v]{26}$
          description: The ID of the file batch.
          title: Batch Id
        description: The ID of the file batch.
      responses:
        '200':
          description: The file batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFileBatch'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel:
    post:
      tags:
      - Vector Stores
      - OpenAI
      summary: Cancel a file batch (OpenAI format)
      description: Stops indexing the files of a batch that have not started yet (OpenAI
        Vector Stores API). Files already indexed stay searchable and keep their `completed`
        status.
      operationId: openai_vector_store_file_batch_cancel
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^vsfb_[0-9a-v]{26}$
          description: The ID of the file batch.
          title: Batch Id
        description: The ID of the file batch.
      responses:
        '200':
          description: The cancelled file batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStoreFileBatch'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files:
    get:
      tags:
      - Vector Stores
      - OpenAI
      summary: List the files of a file batch (OpenAI format)
      description: Returns a paginated list of the files of one batch, with their
        indexing status (OpenAI Vector Stores API).
      operationId: openai_vector_store_file_batch_file_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: vector_store_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^(vs_[0-9a-v]{26}|vs_kb_[0-9A-Za-z]{10})$
          description: The ID of the vector store.
          title: Vector Store Id
        description: The ID of the vector store.
      - name: batch_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^vsfb_[0-9a-v]{26}$
          description: The ID of the file batch.
          title: Batch Id
        description: The ID of the file batch.
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          - type: 'null'
          description: 'Cursor: the object ID to start after.'
          title: After
        description: 'Cursor: the object ID to start after.'
      - name: before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^(file[-_][a-z0-9]{32}|kbdoc_[A-Za-z0-9_-]{1,3000})$
          - type: 'null'
          description: 'Cursor: the object ID to stop before.'
          title: Before
        description: 'Cursor: the object ID to stop before.'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of objects to return, from 1 to 100.
          default: 20
          title: Limit
        description: Number of objects to return, from 1 to 100.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by the `created_at` timestamp of the objects.
          default: desc
          title: Order
        description: Sort order by the `created_at` timestamp of the objects.
      - name: filter
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - in_progress
            - completed
            - failed
            - cancelled
            type: string
          - type: 'null'
          description: Return only files with this status.
          title: Filter
        description: Return only files with this status.
      responses:
        '200':
          description: A list of vector store files.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVectorStoreFilesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/videos:
    post:
      tags:
      - Videos
      - OpenAI
      summary: Start a video generation job (OpenAI format)
      description: 'Starts an asynchronous video generation job from a text prompt
        (OpenAI Videos API).


        Returns a `Video` job object immediately. Poll `openai_video_get` until its
        `status` is `completed`, then download the MP4 with `openai_video_content`.


        **Providing a reference image:** Use `multipart/form-data` to upload a binary
        `input_reference` first-frame image, or `application/json` to pass it as a
        base64 string, data URI, URL, S3 URI, or Files API ID.


        **Find compatible models:** Call `search_models` with `route=openai_video_generation`
        to discover model IDs that support video generation.'
      operationId: openai_video_generation
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_openai_video_generation'
            examples:
              text:
                summary: Text to video
                value:
                  model: amazon.nova-reel-v1:1
                  prompt: A calico cat playing a piano on stage
          application/json:
            examples:
              text:
                summary: Text to video
                value:
                  model: amazon.nova-reel-v1:1
                  prompt: A calico cat playing a piano on stage
                  seconds: '6'
                  size: 1280x720
              image:
                summary: Image to video (first frame)
                value:
                  model: luma.ray-v2:0
                  prompt: The cat starts to play
                  input_reference: https://example.com/frame.png
      responses:
        '200':
          description: Video generation job started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'
        '400':
          description: Invalid request or unsupported parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Videos
      - OpenAI
      summary: List video generation jobs (OpenAI format)
      description: 'Returns a paginated list of video generation jobs, newest first
        by default (OpenAI Videos API).


        A job stays listed for as long as its generation record is retained, independently
        of whether its video content still exists.'
      operationId: openai_video_list
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^video_[A-Za-z0-9_-]+$
          - type: 'null'
          description: 'Cursor for pagination: the video ID to start after (the last
            ID from a previous page).'
          title: After
        description: 'Cursor for pagination: the video ID to start after (the last
          ID from a previous page).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: A limit on the number of objects returned.
          default: 20
          title: Limit
        description: A limit on the number of objects returned.
      - name: order
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          description: Sort order by the `created_at` timestamp of the objects.
          default: desc
          title: Order
        description: Sort order by the `created_at` timestamp of the objects.
      responses:
        '200':
          description: A paginated list of Video objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/videos/{video_id}:
    get:
      tags:
      - Videos
      - OpenAI
      summary: Retrieve a video generation job (OpenAI format)
      description: Returns the current state of a video generation job (OpenAI Videos
        API). Poll this endpoint until `status` is `completed`, then download the
        MP4 with `openai_video_content`.
      operationId: openai_video_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: video_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^video_[A-Za-z0-9_-]+$
          description: The identifier of the video job.
          title: Video Id
        description: The identifier of the video job.
      responses:
        '200':
          description: The video job state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'
        '404':
          description: Video not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Videos
      - OpenAI
      summary: Delete a generated video (OpenAI format)
      description: Permanently deletes the stored output of a finished video generation
        job and returns a deletion confirmation (OpenAI Videos API).
      operationId: openai_video_delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: video_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^video_[A-Za-z0-9_-]+$
          description: The identifier of the video job.
          title: Video Id
        description: The identifier of the video job.
      responses:
        '200':
          description: Video output deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoDeleted'
        '400':
          description: Video is still being processed.
        '404':
          description: Video not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/videos/{video_id}/content:
    get:
      tags:
      - Videos
      - OpenAI
      summary: Download the generated video content (OpenAI format)
      description: 'Returns the generated MP4 video as a streaming download once the
        job has completed (OpenAI Videos API).


        **MCP / AI agent usage:** the video is never returned inline; the tool answers
        with a JSON reference holding the URL to download it from.'
      operationId: openai_video_content
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: video_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^video_[A-Za-z0-9_-]+$
          description: The identifier of the video job.
          title: Video Id
        description: The identifier of the video job.
      - name: variant
        in: query
        required: false
        schema:
          enum:
          - video
          - thumbnail
          - spritesheet
          type: string
          description: Which downloadable asset to return.
          default: video
          title: Variant
        description: Which downloadable asset to return.
      responses:
        '200':
          description: The MP4 video content.
          content:
            application/json:
              schema: {}
        '400':
          description: Requested variant not available.
        '404':
          description: Video not found or not ready yet.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AcknowledgedSafetyCheck:
      properties:
        id:
          type: string
          title: Id
          description: Safety check ID.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Safety check type.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Safety check details.
      additionalProperties: false
      type: object
      required:
      - id
      title: AcknowledgedSafetyCheck
      description: An acknowledged safety check for a computer call output.
    AdditionalTools:
      properties:
        id:
          type: string
          title: Id
          description: Item ID.
        role:
          type: string
          enum:
          - unknown
          - user
          - assistant
          - system
          - critic
          - discriminator
          - developer
          - tool
          title: Role
          description: Role that provided the additional tools.
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
            - $ref: '#/components/schemas/FileSearchTool'
            - $ref: '#/components/schemas/ComputerTool'
            - $ref: '#/components/schemas/ComputerUsePreviewTool'
            - $ref: '#/components/schemas/WebSearchTool'
            - $ref: '#/components/schemas/Mcp'
            - $ref: '#/components/schemas/CodeInterpreter'
            - $ref: '#/components/schemas/ImageGeneration'
            - $ref: '#/components/schemas/LocalShell'
            - $ref: '#/components/schemas/FunctionShellTool'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
            - $ref: '#/components/schemas/NamespaceTool'
            - $ref: '#/components/schemas/ToolSearchTool'
            - $ref: '#/components/schemas/WebSearchPreviewTool'
            - $ref: '#/components/schemas/ApplyPatchTool'
            - $ref: '#/components/schemas/ProgrammaticToolCalling'
            discriminator:
              propertyName: type
              mapping:
                apply_patch: '#/components/schemas/ApplyPatchTool'
                code_interpreter: '#/components/schemas/CodeInterpreter'
                computer: '#/components/schemas/ComputerTool'
                computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                file_search: '#/components/schemas/FileSearchTool'
                function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                image_generation: '#/components/schemas/ImageGeneration'
                local_shell: '#/components/schemas/LocalShell'
                mcp: '#/components/schemas/Mcp'
                namespace: '#/components/schemas/NamespaceTool'
                programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                shell: '#/components/schemas/FunctionShellTool'
                tool_search: '#/components/schemas/ToolSearchTool'
                web_search: '#/components/schemas/WebSearchTool'
                web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
          type: array
          title: Tools
          description: The additional tools.
        type:
          type: string
          const: additional_tools
          title: Type
          description: Item type. Always `additional_tools`.
      additionalProperties: false
      type: object
      required:
      - id
      - role
      - tools
      - type
      title: AdditionalTools
      description: 'An item advertising additional tools.


        No model generates one here: it is returned by a listing when a client

        stored one in a conversation, so a replayed transcript reads back whole.'
    AdditionalToolsInput:
      properties:
        role:
          type: string
          enum:
          - unknown
          - user
          - assistant
          - system
          - critic
          - discriminator
          - developer
          - tool
          title: Role
          description: The role that provided the additional tools.
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
            - $ref: '#/components/schemas/FileSearchTool'
            - $ref: '#/components/schemas/ComputerTool'
            - $ref: '#/components/schemas/ComputerUsePreviewTool'
            - $ref: '#/components/schemas/WebSearchTool'
            - $ref: '#/components/schemas/Mcp'
            - $ref: '#/components/schemas/CodeInterpreter'
            - $ref: '#/components/schemas/ImageGeneration'
            - $ref: '#/components/schemas/LocalShell'
            - $ref: '#/components/schemas/FunctionShellTool'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
            - $ref: '#/components/schemas/NamespaceTool'
            - $ref: '#/components/schemas/ToolSearchTool'
            - $ref: '#/components/schemas/WebSearchPreviewTool'
            - $ref: '#/components/schemas/ApplyPatchTool'
            - $ref: '#/components/schemas/ProgrammaticToolCalling'
            discriminator:
              propertyName: type
              mapping:
                apply_patch: '#/components/schemas/ApplyPatchTool'
                code_interpreter: '#/components/schemas/CodeInterpreter'
                computer: '#/components/schemas/ComputerTool'
                computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                file_search: '#/components/schemas/FileSearchTool'
                function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                image_generation: '#/components/schemas/ImageGeneration'
                local_shell: '#/components/schemas/LocalShell'
                mcp: '#/components/schemas/Mcp'
                namespace: '#/components/schemas/NamespaceTool'
                programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                shell: '#/components/schemas/FunctionShellTool'
                tool_search: '#/components/schemas/ToolSearchTool'
                web_search: '#/components/schemas/WebSearchTool'
                web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
          type: array
          title: Tools
          description: The additional tools.
        type:
          type: string
          const: additional_tools
          title: Type
          description: The type of the item. Always `additional_tools`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the item.
      type: object
      required:
      - role
      - tools
      - type
      title: AdditionalToolsInput
      description: An echoed additional-tools advertisement item (as input item).
    AllThinkingTurnsParam:
      properties:
        type:
          type: string
          const: all
          title: Type
          description: Keep type.
      type: object
      required:
      - type
      title: AllThinkingTurnsParam
      description: Keep the thinking of every assistant turn.
    AmazonBedrockGuardrailConfigParams:
      properties:
        tagSuffix:
          anyOf:
          - type: string
          - type: 'null'
          title: Tagsuffix
          description: Amazon Bedrock Guardrail input tagging. UNSUPPORTED on this
            implementation.
      type: object
      title: AmazonBedrockGuardrailConfigParams
      description: Amazon Bedrock Guardrail configuration parameters.
    Annotation:
      properties:
        type:
          type: string
          const: url_citation
          title: Type
          description: Citation type. Always `url_citation`.
        url_citation:
          $ref: '#/components/schemas/stdapi__types__openai_chat_completions__AnnotationURLCitation'
          description: URL citation from web search.
      additionalProperties: false
      type: object
      required:
      - type
      - url_citation
      title: Annotation
      description: Annotation for the message when using web search.
    AnnotationContainerFileCitation:
      properties:
        container_id:
          type: string
          title: Container Id
          description: Container file ID.
        end_index:
          type: integer
          title: End Index
          description: Last character index of container file citation.
        file_id:
          type: string
          title: File Id
          description: File ID.
        filename:
          type: string
          title: Filename
          description: Container filename.
        start_index:
          type: integer
          title: Start Index
          description: First character index of container file citation.
        type:
          type: string
          const: container_file_citation
          title: Type
          description: Container file citation type.
      additionalProperties: false
      type: object
      required:
      - container_id
      - end_index
      - file_id
      - filename
      - start_index
      - type
      title: AnnotationContainerFileCitation
      description: A citation for a container file used to generate a model response.
    AnnotationFileCitation:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        filename:
          type: string
          title: Filename
          description: Filename.
        index:
          type: integer
          title: Index
          description: File index.
        type:
          type: string
          const: file_citation
          title: Type
          description: File citation type.
      additionalProperties: false
      type: object
      required:
      - file_id
      - filename
      - index
      - type
      title: AnnotationFileCitation
      description: A citation to a file.
    AnnotationFilePath:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        index:
          type: integer
          title: Index
          description: File index.
        type:
          type: string
          const: file_path
          title: Type
          description: File path type.
      additionalProperties: false
      type: object
      required:
      - file_id
      - index
      - type
      title: AnnotationFilePath
      description: A path to a file.
    AnnotationURLCitation-Input:
      properties:
        end_index:
          type: integer
          title: End Index
          description: Last character index of URL citation.
        start_index:
          type: integer
          title: Start Index
          description: First character index of URL citation.
        title:
          type: string
          title: Title
          description: Web resource title.
        type:
          type: string
          const: url_citation
          title: Type
          description: URL citation type.
        url:
          type: string
          title: Url
          description: Web resource URL.
      additionalProperties: false
      type: object
      required:
      - end_index
      - start_index
      - title
      - type
      - url
      title: AnnotationURLCitation
      description: A citation for a web resource used to generate a model response.
    ApiMeta:
      properties:
        api_version:
          $ref: '#/components/schemas/ApiVersion'
          description: API version information.
        billed_units:
          $ref: '#/components/schemas/BilledUnits'
          description: Billing information.
      additionalProperties: false
      type: object
      required:
      - billed_units
      title: ApiMeta
      description: Response metadata.
    ApiVersion:
      properties:
        version:
          type: string
          title: Version
          description: The Cohere API version.
          default: '2'
      additionalProperties: false
      type: object
      title: ApiVersion
      description: API version metadata.
    ApplyPatchCall:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the apply patch tool call generated by the
            model.
        operation:
          oneOf:
          - $ref: '#/components/schemas/ApplyPatchOperationCreateFile'
          - $ref: '#/components/schemas/ApplyPatchOperationDeleteFile'
          - $ref: '#/components/schemas/ApplyPatchOperationUpdateFile'
          title: Operation
          description: The specific create, delete, or update instruction for the
            apply_patch tool call.
          discriminator:
            propertyName: type
            mapping:
              create_file: '#/components/schemas/ApplyPatchOperationCreateFile'
              delete_file: '#/components/schemas/ApplyPatchOperationDeleteFile'
              update_file: '#/components/schemas/ApplyPatchOperationUpdateFile'
        status:
          type: string
          enum:
          - in_progress
          - completed
          title: Status
          description: The status of the apply patch tool call. One of `in_progress`
            or `completed`.
        type:
          type: string
          const: apply_patch_call
          title: Type
          description: The type of the item. Always `apply_patch_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the apply patch tool call. Populated when
            this item is returned via API.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
      type: object
      required:
      - call_id
      - operation
      - status
      - type
      title: ApplyPatchCall
      description: A tool call representing a request to create, delete, or update
        files using diff patches.
    ApplyPatchCallOutput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the apply patch tool call generated by the
            model.
        status:
          type: string
          enum:
          - completed
          - failed
          title: Status
          description: The status of the apply patch tool call output.
        type:
          type: string
          const: apply_patch_call_output
          title: Type
          description: The type of the item. Always `apply_patch_call_output`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the apply patch tool call output. Populated
            when this item is returned via API.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        output:
          anyOf:
          - type: string
          - type: 'null'
          title: Output
          description: Optional human-readable log text from the apply patch tool.
      type: object
      required:
      - call_id
      - status
      - type
      title: ApplyPatchCallOutput
      description: The streamed output emitted by an apply patch tool call (as input
        item).
    ApplyPatchOperationCreateFile:
      properties:
        diff:
          type: string
          title: Diff
          description: Diff content for new file.
        path:
          type: string
          title: Path
          description: Path relative to workspace root.
        type:
          type: string
          const: create_file
          title: Type
          description: Create file operation.
      type: object
      required:
      - diff
      - path
      - type
      title: ApplyPatchOperationCreateFile
      description: Instruction for creating a new file via the apply_patch tool.
    ApplyPatchOperationDeleteFile:
      properties:
        path:
          type: string
          title: Path
          description: Path to delete.
        type:
          type: string
          const: delete_file
          title: Type
          description: Delete file operation.
      type: object
      required:
      - path
      - type
      title: ApplyPatchOperationDeleteFile
      description: Instruction for deleting an existing file via the apply_patch tool.
    ApplyPatchOperationUpdateFile:
      properties:
        diff:
          type: string
          title: Diff
          description: Diff content to apply.
        path:
          type: string
          title: Path
          description: Path to update.
        type:
          type: string
          const: update_file
          title: Type
          description: Update file operation.
      type: object
      required:
      - diff
      - path
      - type
      title: ApplyPatchOperationUpdateFile
      description: Instruction for updating an existing file via the apply_patch tool.
    ApplyPatchTool:
      properties:
        type:
          type: string
          const: apply_patch
          title: Type
          description: Apply patch tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
      type: object
      required:
      - type
      title: ApplyPatchTool
      description: 'Allows the assistant to create, delete, or update files using
        unified diffs.


        UNSUPPORTED on this implementation.'
    Audio:
      properties:
        id:
          type: string
          title: Id
          description: ID of a previous audio response from the model.
      type: object
      required:
      - id
      title: Audio
      description: Data about a previous audio response from the model.
    AudioConfig:
      properties:
        input:
          $ref: '#/components/schemas/AudioInputConfig'
          description: Incoming audio settings.
        output:
          $ref: '#/components/schemas/AudioOutputConfig'
          description: Returned audio settings.
      type: object
      title: AudioConfig
      description: Configuration for input and output audio.
    AudioFormat:
      properties:
        type:
          type: string
          enum:
          - audio/pcm
          - audio/pcmu
          - audio/pcma
          title: Type
          description: 'Audio encoding: 24 kHz 16-bit mono PCM, or G.711 at 8 kHz,
            little-endian and mono in every case.'
          default: audio/pcm
        rate:
          anyOf:
          - type: integer
            const: 24000
          - type: 'null'
          title: Rate
          description: Sample rate of 'audio/pcm', always 24000.
      type: object
      title: AudioFormat
      description: Audio format of one direction of the session.
    AudioInputConfig:
      properties:
        format:
          $ref: '#/components/schemas/AudioFormat'
          description: Format of the incoming audio.
        noise_reduction:
          anyOf:
          - $ref: '#/components/schemas/NoiseReduction'
          - type: 'null'
          description: 'UNSUPPORTED: incoming audio is not filtered.'
        transcription:
          anyOf:
          - $ref: '#/components/schemas/InputAudioTranscription'
          - type: 'null'
          description: Set to receive a transcript of the caller's speech as conversation.item.input_audio_transcription
            events.
        turn_detection:
          anyOf:
          - $ref: '#/components/schemas/TurnDetection'
          - type: 'null'
          description: Turn detection settings, or null to end every turn with input_audio_buffer.commit
            instead.
      type: object
      title: AudioInputConfig
      description: Configuration of the audio the caller sends.
    AudioOutputConfig:
      properties:
        format:
          $ref: '#/components/schemas/AudioFormat'
          description: Format of the returned audio.
        voice:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Voice
          description: Voice the model answers with.
        speed:
          anyOf:
          - type: number
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Speed
          description: 'UNSUPPORTED: the spoken response is not time-scaled.'
      type: object
      title: AudioOutputConfig
      description: Configuration of the audio the model sends back.
    AudioSpeechesResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.audio_speeches.result
          title: Object
          default: organization.usage.audio_speeches.result
        characters:
          type: integer
          title: Characters
          description: Number of characters synthesized.
          default: 0
      additionalProperties: false
      type: object
      title: AudioSpeechesResult
      description: Aggregated speech synthesis usage of one time bucket.
    AudioTranscriptionsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.audio_transcriptions.result
          title: Object
          default: organization.usage.audio_transcriptions.result
        seconds:
          type: integer
          title: Seconds
          description: Number of seconds transcribed.
          default: 0
      additionalProperties: false
      type: object
      title: AudioTranscriptionsResult
      description: Aggregated transcription usage of one time bucket.
    AutoChunkingStrategyParam:
      properties:
        type:
          type: string
          const: auto
          title: Type
          description: Selects the default chunking strategy.
      type: object
      required:
      - type
      title: AutoChunkingStrategyParam
      description: 'Default chunking strategy: 800-token chunks overlapping by 400
        tokens.'
    Base64ImageSource:
      properties:
        type:
          type: string
          const: base64
          title: Type
          description: Image source type.
        media_type:
          type: string
          title: Media Type
          description: Image media type.
        data:
          type: string
          minLength: 1
          title: Data
          description: Base64 encoded image data, data URI, S3 URI, or URL.
      type: object
      required:
      - type
      - media_type
      - data
      title: Base64ImageSource
      description: Image source for image content block.
    Base64PDFSource:
      properties:
        type:
          type: string
          const: base64
          title: Type
          description: Document source type.
        media_type:
          type: string
          const: application/pdf
          title: Media Type
          description: Document media type. Only `application/pdf` is supported.
        data:
          type: string
          minLength: 1
          title: Data
          description: Base64 encoded document data, data URI, S3 URI, or URL.
      type: object
      required:
      - type
      - media_type
      - data
      title: Base64PDFSource
      description: Document source for document content block.
    BashCodeExecutionOutputBlock:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: bash_code_execution_output
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - file_id
      - type
      title: BashCodeExecutionOutputBlock
      description: Bash code execution output block.
    BashCodeExecutionOutputBlockParam:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: bash_code_execution_output
          title: Type
          description: Type discriminator.
      type: object
      required:
      - file_id
      - type
      title: BashCodeExecutionOutputBlockParam
      description: Bash code execution output block parameter.
    BashCodeExecutionResultBlock:
      properties:
        content:
          items:
            $ref: '#/components/schemas/BashCodeExecutionOutputBlock'
          type: array
          title: Content
          description: Block content.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        stdout:
          type: string
          title: Stdout
          description: Stdout.
        type:
          type: string
          const: bash_code_execution_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - return_code
      - stderr
      - stdout
      - type
      title: BashCodeExecutionResultBlock
      description: Bash code execution result block.
    BashCodeExecutionResultBlockParam:
      properties:
        content:
          items:
            $ref: '#/components/schemas/BashCodeExecutionOutputBlockParam'
          type: array
          title: Content
          description: Block content.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        stdout:
          type: string
          title: Stdout
          description: Stdout.
        type:
          type: string
          const: bash_code_execution_result
          title: Type
          description: Type discriminator.
      type: object
      required:
      - content
      - return_code
      - stderr
      - stdout
      - type
      title: BashCodeExecutionResultBlockParam
      description: Bash code execution result block parameter.
    BashCodeExecutionToolResultBlock:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/BashCodeExecutionToolResultError'
          - $ref: '#/components/schemas/BashCodeExecutionResultBlock'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: bash_code_execution_tool_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: BashCodeExecutionToolResultBlock
      description: Bash code execution tool result block.
    BashCodeExecutionToolResultBlockParam:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/BashCodeExecutionToolResultErrorParam'
          - $ref: '#/components/schemas/BashCodeExecutionResultBlockParam'
          title: Content
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: bash_code_execution_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: BashCodeExecutionToolResultBlockParam
      description: Bash code execution tool result block parameter.
    BashCodeExecutionToolResultError:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - too_many_requests
          - execution_time_exceeded
          - output_file_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: bash_code_execution_tool_result_error
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: BashCodeExecutionToolResultError
      description: Bash code execution tool result error.
    BashCodeExecutionToolResultErrorParam:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - too_many_requests
          - execution_time_exceeded
          - output_file_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: bash_code_execution_tool_result_error
          title: Type
          description: Type discriminator.
      type: object
      required:
      - error_code
      - type
      title: BashCodeExecutionToolResultErrorParam
      description: Bash code execution tool result error parameter.
    Batch:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the batch.
        object:
          type: string
          const: batch
          title: Object
          description: The object type, which is always `batch`.
          default: batch
        endpoint:
          type: string
          title: Endpoint
          description: The API endpoint the batch targets.
        errors:
          anyOf:
          - $ref: '#/components/schemas/BatchErrors'
          - type: 'null'
          description: Batch-level errors, when the batch failed.
        input_file_id:
          type: string
          title: Input File Id
          description: ID of the batch's input file.
        completion_window:
          type: string
          title: Completion Window
          description: The time frame within which the batch is processed.
        status:
          type: string
          enum:
          - validating
          - failed
          - in_progress
          - finalizing
          - completed
          - expired
          - cancelling
          - cancelled
          title: Status
          description: Current status of the batch.
        output_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Output File Id
          description: ID of the file holding the results of the requests that completed
            successfully. Available once the batch has ended.
        error_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Error File Id
          description: ID of the file holding the results of the requests that failed.
            Available once the batch has ended and at least one request failed.
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (in seconds) when the batch was created.
        in_progress_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: In Progress At
          description: Unix timestamp (in seconds) when the batch started running.
        expires_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires At
          description: Unix timestamp (in seconds) when the batch stops being processed.
        finalizing_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Finalizing At
          description: Unix timestamp (in seconds) when the batch started finalizing.
        completed_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Completed At
          description: Unix timestamp (in seconds) when the batch completed.
        failed_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Failed At
          description: Unix timestamp (in seconds) when the batch failed.
        expired_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expired At
          description: Unix timestamp (in seconds) when the batch expired.
        cancelling_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cancelling At
          description: Unix timestamp (in seconds) when cancellation started.
        cancelled_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cancelled At
          description: Unix timestamp (in seconds) when the batch was cancelled.
        request_counts:
          anyOf:
          - $ref: '#/components/schemas/BatchRequestCounts'
          - type: 'null'
          description: Counts of requests in the batch, by outcome.
        usage:
          anyOf:
          - $ref: '#/components/schemas/BatchUsage'
          - type: 'null'
          description: Token usage totalled over the batch, once it has ended.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: The model every request in the batch used.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: The key-value pairs attached to the batch.
      additionalProperties: false
      type: object
      required:
      - id
      - endpoint
      - input_file_id
      - completion_window
      - status
      - created_at
      title: Batch
      description: A batch of requests processed asynchronously (OpenAI Batch API).
    BatchCreateParams:
      properties:
        input_file_id:
          type: string
          title: Input File Id
          description: ID of an uploaded file holding the requests to run, one JSON
            object per line. The file must have been uploaded with `purpose='batch'`,
            and every line must name the same model.
        endpoint:
          type: string
          enum:
          - /v1/chat/completions
          - /v1/embeddings
          title: Endpoint
          description: The API endpoint every request in the file targets. `/v1/chat/completions`
            and `/v1/embeddings` are the endpoints available for batches.
        completion_window:
          type: string
          const: 24h
          title: Completion Window
          description: The time frame within which the batch is processed. `24h` is
            the only accepted value.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
            maxProperties: 16
          - type: 'null'
          title: Metadata
          description: Up to 16 key-value pairs stored with the batch and returned
            on every read. Keys are at most 64 characters, values at most 512.
        output_expires_after:
          anyOf:
          - $ref: '#/components/schemas/BatchOutputExpiresAfter'
          - type: 'null'
          description: Expiration policy for the result files. Once expired, they
            are no longer readable and are deleted. Omit it to keep them until they
            are deleted with `openai_file_delete`.
      type: object
      required:
      - input_file_id
      - endpoint
      - completion_window
      title: BatchCreateParams
      description: Batch creation parameters (OpenAI Batch API).
    BatchError:
      properties:
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Machine-readable error code.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Human-readable description of the error.
        param:
          anyOf:
          - type: string
          - type: 'null'
          title: Param
          description: Name of the request parameter that caused the error, if any.
        line:
          anyOf:
          - type: integer
          - type: 'null'
          title: Line
          description: Line number in the input file where the error occurred, if
            any.
      additionalProperties: false
      type: object
      title: BatchError
      description: A validation error that prevented a batch from being created or
        run.
    BatchErrors:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/BatchError'
          type: array
          title: Data
          description: The batch-level errors.
      additionalProperties: false
      type: object
      title: BatchErrors
      description: List of batch-level errors.
    BatchList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/Batch'
          type: array
          title: Data
          description: List of Batch objects.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      title: BatchList
      description: Paginated list of batches.
    BatchOutputExpiresAfter:
      properties:
        anchor:
          type: string
          const: created_at
          title: Anchor
          description: 'Timestamp the expiration is counted from: the creation of
            the result files, not of the batch. `created_at` is the only accepted
            value.'
        seconds:
          type: integer
          maximum: 2592000.0
          minimum: 3600.0
          title: Seconds
          description: Number of seconds the result files stay readable, between 3600
            (1 hour) and 2592000 (30 days).
      type: object
      required:
      - anchor
      - seconds
      title: BatchOutputExpiresAfter
      description: Expiration policy for the files a batch produces.
    BatchRequestCounts:
      properties:
        total:
          type: integer
          title: Total
          description: Total number of requests in the batch.
        completed:
          type: integer
          title: Completed
          description: Number of requests that completed successfully.
        failed:
          type: integer
          title: Failed
          description: Number of requests that failed.
      additionalProperties: false
      type: object
      required:
      - total
      - completed
      - failed
      title: BatchRequestCounts
      description: Counts of requests in the batch, by outcome.
    BatchUsage:
      properties:
        input_tokens:
          type: integer
          title: Input Tokens
          description: Number of input tokens.
        input_tokens_details:
          $ref: '#/components/schemas/BatchUsageInputTokensDetails'
          description: Breakdown of the input tokens.
        output_tokens:
          type: integer
          title: Output Tokens
          description: Number of output tokens.
        output_tokens_details:
          $ref: '#/components/schemas/BatchUsageOutputTokensDetails'
          description: Breakdown of the output tokens.
        total_tokens:
          type: integer
          title: Total Tokens
          description: Total number of tokens used.
      additionalProperties: false
      type: object
      required:
      - input_tokens
      - output_tokens
      - total_tokens
      title: BatchUsage
      description: Token usage totalled over every request in the batch.
    BatchUsageInputTokensDetails:
      properties:
        cached_tokens:
          type: integer
          title: Cached Tokens
          description: Number of input tokens served from the prompt cache.
          default: 0
      additionalProperties: false
      type: object
      title: BatchUsageInputTokensDetails
      description: Breakdown of the batch's input tokens.
    BatchUsageOutputTokensDetails:
      properties:
        reasoning_tokens:
          type: integer
          title: Reasoning Tokens
          description: Number of output tokens spent on reasoning.
          default: 0
      additionalProperties: false
      type: object
      title: BatchUsageOutputTokensDetails
      description: Breakdown of the batch's output tokens.
    BilledUnits:
      properties:
        input_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Input Tokens
          description: Billed input tokens.
        images:
          anyOf:
          - type: integer
          - type: 'null'
          title: Images
          description: Billed input images.
        search_units:
          anyOf:
          - type: integer
          - type: 'null'
          title: Search Units
          description: Billed search units (one unit covers a query with up to 100
            documents).
      additionalProperties: false
      type: object
      title: BilledUnits
      description: Billed units metadata.
    Body_anthropic_file:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
          description: The file to upload. Use an ``application/json`` body to pass
            a base64 string, data URI, or URL instead.
        expires_in_seconds:
          anyOf:
          - type: integer
            maximum: 7776000.0
            minimum: 3600.0
          - type: 'null'
          title: Expires In Seconds
          description: Seconds from upload until the file expires (1 hour to 90 days).
            Omit to keep the file until it is manually deleted.
      type: object
      title: Body_anthropic_file
    Body_openai_audio_transcription:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
          description: 'The audio file to transcribe, in one of these formats: flac,
            mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. Use an ``application/json``
            body to pass a base64 string, data URI, or URL instead.'
        model:
          type: string
          title: Model
          description: 'The transcription model to use.

            `amazon.transcribe`, `amazon.transcribe-medical` (clinical dictation and
            conversations, US English only, no `srt`/`vtt`), `amazon.nova-2-sonic-v1:0`
            (lowest cost, `json`/`text` output only, no timestamps, 10 minutes of
            audio maximum), or another speech-to-text model (e.g. Mistral Voxtral).
            Wildcard patterns are accepted and select the most recent matching model.'
          default: amazon.transcribe
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
          description: 'The language of the input audio.

            Supplying it in ISO-639-1 format (e.g. `en`) improves accuracy and latency.'
        languages:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Languages
          description: 'Expected input languages in ISO-639-1 format (e.g. `en`) when
            the audio may contain more than one language.

            Cannot be combined with `language`.'
        keywords:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keywords
          description: 'Literal terms that may appear in the audio (e.g. product names
            or acronyms).

            Supported by speech-to-text models that accept a transcription context
            (e.g. Mistral Voxtral); rejected by `amazon.transcribe` — use a pre-created
            custom vocabulary via the `VocabularyName` extra parameter instead.'
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
          description: 'An optional text to guide the model''s style or continue a
            previous audio segment.

            The prompt should match the audio language.'
        chunking_strategy:
          anyOf:
          - type: string
            const: auto
          - $ref: '#/components/schemas/ChunkingStrategyVadConfig'
          title: Chunking Strategy
          description: 'Controls how the audio is cut into chunks.

            `auto` normalizes loudness then uses voice activity detection (VAD) to
            choose boundaries; a `server_vad` object tunes VAD parameters manually.

            server_vad is UNSUPPORTED on this implementation.'
          default: auto
        response_format:
          type: string
          enum:
          - json
          - text
          - srt
          - verbose_json
          - vtt
          - diarized_json
          title: Response Format
          description: 'Transcript output format.

            `srt`, `vtt`, `verbose_json` and `diarized_json` need a model that produces
            timestamps, such as `amazon.transcribe`.

            `srt` and `vtt` cannot be combined with `stream=true`.'
          default: json
        timestamp_granularities:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Timestamp Granularities
          description: 'Timestamp granularities to populate: `word` and/or `segment`
            (e.g. `["word", "segment"]`).

            Requires `response_format=verbose_json`.'
        include:
          anyOf:
          - items:
              type: string
              const: logprobs
            type: array
          - type: 'null'
          title: Include
          description: 'Additional information to include in the transcription response.

            `logprobs` returns token log probabilities (confidence) and only works
            with `response_format=json`.'
        temperature:
          anyOf:
          - type: number
          - type: 'null'
          title: Temperature
          description: 'The sampling temperature, between `0` and `1`.

            Higher values like `0.8` will make the output more random, while lower
            values like `0.2` will make it more focused and deterministic.'
        stream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Stream
          description: 'If set to true, the model response data will be streamed to
            the client as it is generated using server-sent events.

            Emits `transcript.text.delta` events then `transcript.text.done`, plus
            a `transcript.text.segment` event per speaker segment with `response_format=diarized_json`
            on a model that labels speakers, such as `amazon.transcribe`.'
          default: false
        known_speaker_names:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Known Speaker Names
          description: 'Speaker names corresponding to the samples in `known_speaker_references`
            (e.g. `customer`, `agent`).

            Accepted but ignored: diarization degrades to generic speaker labels.'
        known_speaker_references:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Known Speaker References
          description: 'Audio samples (as data URLs, 2-10 seconds each, same formats
            as `file`) for known-speaker diarization, matching `known_speaker_names`.

            Accepted but ignored: diarization degrades to generic speaker labels.'
      type: object
      title: Body_openai_audio_transcription
    Body_openai_audio_translation:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
          description: 'The audio file to translate, in one of these formats: flac,
            m4a, mp3, mp4, mpeg, mpga, oga, ogg, wav, webm. Use an ``application/json``
            body to pass a base64 string, data URI, or URL instead.'
        model:
          type: string
          title: Model
          description: 'The transcription model to use.

            `amazon.transcribe`, `amazon.nova-2-sonic-v1:0` (lowest cost, `json`/`text`
            output only, no timestamps, 10 minutes of audio maximum), or another speech-to-text
            model (e.g. Mistral Voxtral). Wildcard patterns are accepted and select
            the most recent matching model.'
          default: amazon.transcribe
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
          description: 'An optional text to guide the model''s style or continue a
            previous audio segment.

            The prompt should be in English.

            Supported by speech-to-text models such as Mistral Voxtral; rejected by
            `amazon.transcribe`.'
        response_format:
          type: string
          enum:
          - json
          - text
          - srt
          - verbose_json
          - vtt
          title: Response Format
          description: 'Transcript output format.

            `srt`, `vtt` and `verbose_json` need a model that produces timestamps,
            such as `amazon.transcribe`.'
          default: json
        temperature:
          anyOf:
          - type: number
          - type: 'null'
          title: Temperature
          description: 'The sampling temperature, between `0` and `1`.

            Higher values like `0.8` will make the output more random, while lower
            values like `0.2` will make it more focused and deterministic.'
      type: object
      title: Body_openai_audio_translation
    Body_openai_file:
      properties:
        file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: File
          description: The File object (not file name) to be uploaded. Use an ``application/json``
            body to pass a base64 string, data URI, or URL instead.
        purpose:
          type: string
          enum:
          - assistants
          - batch
          - fine-tune
          - vision
          - user_data
          - evals
          title: Purpose
          description: 'Intended purpose of the file: `assistants` (Assistants API),
            `batch` (Batch API), `fine-tune` (fine-tuning), `vision` (vision fine-tuning
            images), `user_data` (any purpose), or `evals` (eval datasets).'
          default: assistants
        expires_after_anchor:
          anyOf:
          - type: string
            const: created_at
          - type: 'null'
          title: Expires After Anchor
          description: 'Anchor timestamp after which the expiration policy applies.
            Supported anchors: `created_at`.'
        expires_after_seconds:
          anyOf:
          - type: integer
            maximum: 2592000.0
            minimum: 3600.0
          - type: 'null'
          title: Expires After Seconds
          description: Seconds after the anchor time until the file expires (1 hour
            to 30 days). By default, `purpose=batch` files expire after 30 days; all
            other files persist until manually deleted.
      type: object
      title: Body_openai_file
    Body_openai_image_edit:
      properties:
        image:
          anyOf:
          - items:
              type: string
              contentMediaType: application/octet-stream
            type: array
          - type: 'null'
          title: Image
          description: The image(s) to edit. Accepts binary file uploads. For Files
            API identifiers or URLs, use ``application/json`` body instead.
        prompt:
          type: string
          title: Prompt
          description: A text description of the desired image(s). Required for a
            majority of models.
          default: ''
        model:
          type: string
          maxLength: 255
          title: Model
          description: The model to use for image generation. Wildcard patterns are
            accepted and select the most recent matching model.
          default: ''
        mask:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: Mask
          description: An additional image indicating where the image should be edited.
            The mask format is model-specific and may be a black/white image or an
            image with transparency (e.g. where alpha is zero indicates areas to edit).
        response_format:
          type: string
          title: Response Format
          description: 'The format for returned images: url or b64_json. URLs expire
            after 60 minutes. Streaming always returns base64-encoded images, regardless
            of this setting.'
          default: url
        n:
          type: integer
          maximum: 10.0
          minimum: 1.0
          title: N
          description: The number of images to generate.
          default: 1
        size:
          type: string
          pattern: ^(auto|\d+x\d+)$
          title: Size
          description: The size of the generated images, as `WIDTHxHEIGHT`, or `auto`
            to let the model pick. Supported values depend on the model; output size
            may differ for some models.
          default: 1024x1024
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: A unique identifier representing your end-user, which can help
            to monitor and detect abuse.
        background:
          anyOf:
          - type: string
            const: auto
          - type: string
            enum:
            - transparent
            - opaque
          title: Background
          description: 'Background transparency setting. If `transparent`, `output_format`
            must be `png` or `webp`.

            transparent is UNSUPPORTED on this implementation.'
          default: auto
        input_fidelity:
          type: string
          enum:
          - low
          - high
          title: Input Fidelity
          description: 'Effort level for matching the style and features (especially
            facial features) of input images.

            UNSUPPORTED on this implementation.'
          default: low
        output_compression:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Output Compression
          description: The compression level (0-100%) for the generated images.
          default: 100
        output_format:
          anyOf:
          - type: string
            enum:
            - png
            - jpeg
            - webp
          - type: 'null'
          title: Output Format
          description: 'The output image format: `png`, `jpeg`, or `webp`.'
        partial_images:
          anyOf:
          - type: integer
            maximum: 3.0
            minimum: 0.0
          - type: 'null'
          title: Partial Images
          description: Number of partial images to generate during streaming (0-3;
            requires `stream=true`). 0 sends the final image as a single event. The
            final image may arrive before all partial images if generation finishes
            early, and partial images are only sent if the model supports them.
        quality:
          type: string
          maxLength: 255
          minLength: 1
          title: Quality
          description: Image quality. `auto` selects the best quality for the model;
            supported values depend on the model.
          default: auto
        stream:
          type: boolean
          title: Stream
          description: Generate the image in streaming mode.
          default: false
      type: object
      title: Body_openai_image_edit
    Body_openai_image_variation:
      properties:
        image:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: Image
          description: The image to use as the basis for the variation(s). Accepts
            a binary file upload. For Files API identifiers or URLs, use ``application/json``
            body instead.
        model:
          type: string
          maxLength: 255
          title: Model
          description: The model to use for image generation. Wildcard patterns are
            accepted and select the most recent matching model.
          default: ''
        response_format:
          type: string
          title: Response Format
          description: 'The format for returned images: url or b64_json. URLs expire
            after 60 minutes.'
          default: url
        n:
          type: integer
          maximum: 10.0
          minimum: 1.0
          title: N
          description: The number of images to generate.
          default: 1
        size:
          type: string
          pattern: ^(auto|\d+x\d+)$
          title: Size
          description: The size of the generated images, as `WIDTHxHEIGHT`, or `auto`
            to let the model pick. Supported values depend on the model; output size
            may differ for some models.
          default: 1024x1024
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: A unique identifier representing your end-user, which can help
            to monitor and detect abuse.
      type: object
      title: Body_openai_image_variation
    Body_openai_upload_part:
      properties:
        data:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: Data
          description: The chunk of bytes for this Part, at most 5 GiB (the storage
            backend's own per-part maximum).
      type: object
      title: Body_openai_upload_part
    Body_openai_video_generation:
      properties:
        input_reference:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: 'null'
          title: Input Reference
          description: Optional image used as the video's first frame. Use an ``application/json``
            body to pass a base64 string, data URI, URL, S3 URI, or Files API ID instead.
        prompt:
          type: string
          title: Prompt
          description: Text prompt that describes the video to generate.
          default: ''
        model:
          type: string
          title: Model
          description: The video generation model to use. Wildcard patterns are accepted
            and select the most recent matching model.
          default: ''
        seconds:
          anyOf:
          - type: string
          - type: 'null'
          title: Seconds
          description: Clip duration in seconds. Supported values depend on the model;
            defaults to the model's shortest duration.
        size:
          anyOf:
          - type: string
          - type: 'null'
          title: Size
          description: Output resolution as `<width>x<height>`. Supported values depend
            on the model.
      type: object
      title: Body_openai_video_generation
    BrowserStateBlockParam:
      properties:
        type:
          type: string
          const: browser_state
          title: Type
          description: Content block type. Always `browser_state`.
        tabs:
          items:
            $ref: '#/components/schemas/BrowserStateTabEntryParam'
          type: array
          title: Tabs
          description: 'Every tab open after the call: the full inventory, not a delta.
            May be empty.'
        state_changes:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/BrowserStateChangeTabOpenedParam'
              - $ref: '#/components/schemas/BrowserStateChangeDownloadStartedParam'
              - $ref: '#/components/schemas/BrowserStateChangeDownloadCompletedParam'
              - $ref: '#/components/schemas/BrowserStateChangeDownloadFailedParam'
              discriminator:
                propertyName: type
                mapping:
                  download_completed: '#/components/schemas/BrowserStateChangeDownloadCompletedParam'
                  download_failed: '#/components/schemas/BrowserStateChangeDownloadFailedParam'
                  download_started: '#/components/schemas/BrowserStateChangeDownloadStartedParam'
                  tab_opened: '#/components/schemas/BrowserStateChangeTabOpenedParam'
            type: array
          - type: 'null'
          title: State Changes
          description: Tabs opened and download state changes during the call. Omit
            it when there is nothing to report, rather than sending an empty list.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
      type: object
      required:
      - type
      - tabs
      title: BrowserStateBlockParam
      description: 'Browser state after a call to a member of the browser toolset.


        At most one per `tool_result`, and only on a non-error result.

        UNSUPPORTED except on models whose own API runs the browser toolset: every

        other model refuses a request replaying one, since the block is the whole

        payload of the result it belongs to.'
    BrowserStateChangeDownloadCompletedParam:
      properties:
        type:
          type: string
          const: download_completed
          title: Type
          description: State change type. Always `download_completed`.
        download_id:
          type: string
          title: Download Id
          description: Identifier you gave this download, stable across its state
            changes.
        url:
          type: string
          title: Url
          description: Final post-redirect URL the download came from.
        path:
          anyOf:
          - type: string
          - type: 'null'
          title: Path
          description: Where the file was saved, when another tool of the same environment
            can read it there.
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: Size of the completed download, in bytes.
      type: object
      required:
      - type
      - download_id
      - url
      title: BrowserStateChangeDownloadCompletedParam
      description: A file download that finished during the call.
    BrowserStateChangeDownloadFailedParam:
      properties:
        type:
          type: string
          const: download_failed
          title: Type
          description: State change type. Always `download_failed`.
        download_id:
          type: string
          title: Download Id
          description: Identifier you gave this download, stable across its state
            changes.
        url:
          type: string
          title: Url
          description: Final post-redirect URL the download came from.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Failure or cancellation detail, when known.
      type: object
      required:
      - type
      - download_id
      - url
      title: BrowserStateChangeDownloadFailedParam
      description: A file download that failed, or was cancelled, during the call.
    BrowserStateChangeDownloadStartedParam:
      properties:
        type:
          type: string
          const: download_started
          title: Type
          description: State change type. Always `download_started`.
        download_id:
          type: string
          title: Download Id
          description: Identifier you gave this download, stable across its state
            changes.
        url:
          type: string
          title: Url
          description: Final post-redirect URL the download came from.
      type: object
      required:
      - type
      - download_id
      - url
      title: BrowserStateChangeDownloadStartedParam
      description: A file download that started during the call.
    BrowserStateChangeTabOpenedParam:
      properties:
        type:
          type: string
          const: tab_opened
          title: Type
          description: State change type. Always `tab_opened`.
        tab_id:
          type: string
          title: Tab Id
          description: Identifier of the opened tab, also listed in the inventory.
      type: object
      required:
      - type
      - tab_id
      title: BrowserStateChangeTabOpenedParam
      description: A tab the call opened that is still open when it ends.
    BrowserStateTabEntryParam:
      properties:
        tab_id:
          type: string
          title: Tab Id
          description: Identifier you gave this tab, unique within the inventory.
        title:
          type: string
          title: Title
          description: Title of the page the tab shows. May be an empty string.
        url:
          type: string
          title: Url
          description: URL of the page the tab shows. May be an empty string.
        active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Active
          description: Whether this tab is the active one after the call. Exactly
            one entry of a non-empty inventory carries it.
      type: object
      required:
      - tab_id
      - title
      - url
      title: BrowserStateTabEntryParam
      description: One open browser tab reported in a `browser_state` inventory.
    BrowserToolsetParam:
      properties:
        type:
          type: string
          pattern: ^browser_toolset(?:_[0-9]{8})?$
          title: Type
          description: Tool type. The dated browser toolset version, e.g. `browser_toolset_20260801`.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this tool.
        configs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/ToolsetMemberConfigParam'
            type: object
          - type: 'null'
          title: Configs
          description: Per-member configuration, keyed by member name — the same name
            that member's `tool_use` blocks carry. A member left out keeps its defaults.
      type: object
      required:
      - type
      title: BrowserToolsetParam
      description: 'Every browser tool, declared as one `tools` entry.


        The entry has no name and no schema of its own: it names the family, and

        `configs` tunes its members.

        UNSUPPORTED except on models whose own API runs the toolset: every other

        model refuses the request rather than answer it without a browser.'
    CacheControlEphemeralParam:
      properties:
        type:
          type: string
          const: ephemeral
          title: Type
          description: Cache control type.
          default: ephemeral
        ttl:
          anyOf:
          - type: string
            enum:
            - 5m
            - 1h
          - type: 'null'
          title: Ttl
          description: Cache TTL.
      type: object
      title: CacheControlEphemeralParam
      description: Cache control configuration for prompt caching.
    CacheCreation:
      properties:
        ephemeral_1h_input_tokens:
          type: integer
          title: Ephemeral 1H Input Tokens
          description: The number of input tokens used to create the 1 hour cache
            entry.
        ephemeral_5m_input_tokens:
          type: integer
          title: Ephemeral 5M Input Tokens
          description: The number of input tokens used to create the 5 minute cache
            entry.
      additionalProperties: false
      type: object
      required:
      - ephemeral_1h_input_tokens
      - ephemeral_5m_input_tokens
      title: CacheCreation
      description: Cache creation token usage breakdown.
    CallerDirect:
      properties:
        type:
          type: string
          const: direct
          title: Type
          description: Direct caller type.
      type: object
      required:
      - type
      title: CallerDirect
      description: A tool call made directly by the model.
    CallerProgram:
      properties:
        caller_id:
          type: string
          title: Caller Id
          description: ID of the program that made the call.
        type:
          type: string
          const: program
          title: Type
          description: Program caller type.
      type: object
      required:
      - caller_id
      - type
      title: CallerProgram
      description: A tool call made by a program during programmatic tool calling.
    ChatCompletion:
      properties:
        id:
          type: string
          title: Id
          description: Unique ID for the chat completion.
        created:
          type: integer
          title: Created
          description: Unix timestamp (seconds) when the chat completion was created.
        model:
          type: string
          title: Model
          description: Model used for the chat completion.
        usage:
          anyOf:
          - $ref: '#/components/schemas/CompletionUsage'
          - type: 'null'
          description: Usage statistics for the completion request.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - reserved
          - type: 'null'
          title: Service Tier
          description: 'Processing tier the request asked for, after alias mapping:
            `fast` is reported as `priority`, and a tier with no equivalent as `default`.'
        system_fingerprint:
          anyOf:
          - type: string
          - type: 'null'
          title: System Fingerprint
          description: Backend configuration fingerprint. Use with `seed` to check
            for determinism changes.
        moderation:
          anyOf:
          - $ref: '#/components/schemas/ChatModeration'
          - type: 'null'
          description: Guardrail moderation results, when the request set `moderation`.
            When streaming, they are reported in a dedicated moderation chunk with
            empty `choices`, sent last.
        choices:
          items:
            $ref: '#/components/schemas/Choice'
          type: array
          title: Choices
          description: List of chat completion choices. Can be multiple if `n > 1`.
        object:
          type: string
          const: chat.completion
          title: Object
          description: Object type. Always `chat.completion`.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Key-value pairs attached to the chat completion, echoed from
            the request and updatable on stored chat completions.
      additionalProperties: false
      type: object
      required:
      - id
      - created
      - model
      - choices
      - object
      title: ChatCompletion
      description: OpenAI-compatible chat completion object (non-streaming).
    ChatCompletionAllowedToolChoiceParam:
      properties:
        type:
          type: string
          const: allowed_tools
          title: Type
          description: Allowed tools choice type. Always `allowed_tools`.
        allowed_tools:
          $ref: '#/components/schemas/ChatCompletionAllowedToolsParam'
          description: Constrains the tools available to the model to a pre-defined
            set.
      type: object
      required:
      - type
      - allowed_tools
      title: ChatCompletionAllowedToolChoiceParam
      description: 'Allowed tools list choice. UNSUPPORTED on this implementation:
        rejected.'
    ChatCompletionAllowedToolsParam:
      properties:
        mode:
          type: string
          enum:
          - auto
          - required
          title: Mode
          description: 'Tool selection mode: `auto` lets model pick, `required` forces
            a tool call.'
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceParam'
            - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam'
            discriminator:
              propertyName: type
              mapping:
                custom: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam'
                function: '#/components/schemas/ChatCompletionNamedToolChoiceParam'
          type: array
          title: Tools
          description: List of tool definitions the model can call.
      type: object
      required:
      - mode
      - tools
      title: ChatCompletionAllowedToolsParam
      description: Allowed tools for function tools.
    ChatCompletionAssistantMessageParam:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Optional participant name to differentiate same-role participants.
            Accepted and ignored on Amazon Bedrock Converse models, whose messages
            carry no author field; forwarded on Bedrock Mantle passthrough models.
        role:
          type: string
          const: assistant
          title: Role
          description: Message author role. Always `assistant`.
        audio:
          anyOf:
          - $ref: '#/components/schemas/Audio'
          - type: 'null'
          description: Data about a previous audio response from the model.
        content:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartRefusalParam'
              discriminator:
                propertyName: type
                mapping:
                  refusal: '#/components/schemas/ChatCompletionContentPartRefusalParam'
                  text: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          - type: 'null'
          title: Content
          description: Assistant message content. Required unless `tool_calls` or
            `function_call` is specified.
        function_call:
          anyOf:
          - $ref: '#/components/schemas/FunctionCall'
          - type: 'null'
          description: Deprecated. Use `tool_calls` instead. Function name and arguments.
        refusal:
          anyOf:
          - type: string
          - type: 'null'
          title: Refusal
          description: Refusal message from the assistant.
        tool_calls:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/ChatCompletionMessageFunctionToolCall'
              - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall'
              discriminator:
                propertyName: type
                mapping:
                  custom: '#/components/schemas/ChatCompletionMessageCustomToolCall'
                  function: '#/components/schemas/ChatCompletionMessageFunctionToolCall'
            type: array
          - type: 'null'
          title: Tool Calls
          description: Tool calls generated by the model.
        reasoning_content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          - type: 'null'
          title: Reasoning Content
          description: Reasoning content, also accepted under the `reasoning` name.
            Extra field from Deepseek Chat Completion API.
        prefix:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Prefix
          description: Force model to start with the provided prefix. UNSUPPORTED
            on this implementation.
      type: object
      required:
      - role
      title: ChatCompletionAssistantMessageParam
      description: Assistant role message.
    ChatCompletionAudio:
      properties:
        id:
          type: string
          title: Id
          description: Unique ID for this audio response.
        data:
          type: string
          title: Data
          description: Base64-encoded audio bytes in the requested format.
        expires_at:
          type: integer
          minimum: 0.0
          title: Expires At
          description: Unix timestamp (seconds) when audio expires and is no longer
            accessible.
        transcript:
          type: string
          title: Transcript
          description: Transcript of the generated audio.
      additionalProperties: false
      type: object
      required:
      - id
      - data
      - expires_at
      - transcript
      title: ChatCompletionAudio
      description: If audio output modality is requested, contains data about the
        audio response.
    ChatCompletionAudioParam:
      properties:
        format:
          type: string
          enum:
          - wav
          - aac
          - mp3
          - flac
          - opus
          - pcm16
          title: Format
          description: 'Output audio format: `wav`, `aac`, `mp3`, `flac`, `opus`,
            or `pcm16`.'
        voice:
          type: string
          maxLength: 255
          minLength: 1
          title: Voice
          description: Voice for audio response.
      type: object
      required:
      - format
      - voice
      title: ChatCompletionAudioParam
      description: Parameters for audio output.
    ChatCompletionContentPartImageParam:
      properties:
        type:
          type: string
          const: image_url
          title: Type
          description: Content part type. Always `image_url`.
        image_url:
          $ref: '#/components/schemas/ImageURL'
          description: URL descriptor containing the image `url` field.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      - image_url
      title: ChatCompletionContentPartImageParam
      description: Image message content part (via URL).
    ChatCompletionContentPartInputAudioParam:
      properties:
        input_audio:
          $ref: '#/components/schemas/InputAudio'
          description: Audio data descriptor.
        type:
          type: string
          const: input_audio
          title: Type
          description: Content part type. Always `input_audio`.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - input_audio
      - type
      title: ChatCompletionContentPartInputAudioParam
      description: Input audio message content part.
    ChatCompletionContentPartRefusalParam:
      properties:
        type:
          type: string
          const: refusal
          title: Type
          description: Content part type. Always `refusal`.
        refusal:
          type: string
          title: Refusal
          description: Refusal content text.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      - refusal
      title: ChatCompletionContentPartRefusalParam
      description: Refusal message content part.
    ChatCompletionContentPartTextParam:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content part type. Always `text`.
        text:
          type: string
          title: Text
          description: Text content of the message part.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      - text
      title: ChatCompletionContentPartTextParam
      description: Text message content part.
    ChatCompletionCustomToolParam:
      properties:
        type:
          type: string
          const: custom
          title: Type
          description: Tool type. Always `custom`. UNSUPPORTED on this implementation.
        custom:
          $ref: '#/components/schemas/Custom'
          description: Custom tool properties. UNSUPPORTED on this implementation.
      type: object
      required:
      - type
      - custom
      title: ChatCompletionCustomToolParam
      description: 'Custom tool specification.


        UNSUPPORTED on this implementation.'
    ChatCompletionDeleted:
      properties:
        id:
          type: string
          title: Id
          description: Identifier of the deleted chat completion.
        object:
          type: string
          const: chat.completion.deleted
          title: Object
          description: The object type, which is always `chat.completion.deleted`.
          default: chat.completion.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Whether the chat completion was deleted.
          default: true
      additionalProperties: false
      type: object
      required:
      - id
      title: ChatCompletionDeleted
      description: Stored chat completion deletion confirmation.
    ChatCompletionDeveloperMessageParam:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Optional participant name to differentiate same-role participants.
            Accepted and ignored on Amazon Bedrock Converse models, whose messages
            carry no author field; forwarded on Bedrock Mantle passthrough models.
        role:
          type: string
          const: developer
          title: Role
          description: Message author role. Always `developer`.
        content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/_DeveloperContentPartTextParam'
            type: array
          title: Content
          description: Developer message content.
      type: object
      required:
      - role
      - content
      title: ChatCompletionDeveloperMessageParam
      description: Developer role message.
    ChatCompletionFunctionMessageParam:
      properties:
        role:
          type: string
          const: function
          title: Role
          description: Message author role. Always `function`.
        name:
          type: string
          title: Name
          description: The name of the function to call.
        content:
          anyOf:
          - type: string
          - type: 'null'
          title: Content
          description: Function message content.
      type: object
      required:
      - role
      - name
      - content
      title: ChatCompletionFunctionMessageParam
      description: Function role message.
    ChatCompletionFunctionToolParam:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: Tool type. Always `function`.
        function:
          $ref: '#/components/schemas/FunctionDefinition'
          description: Function definition.
      type: object
      required:
      - type
      - function
      title: ChatCompletionFunctionToolParam
      description: Function tool specification.
    ChatCompletionList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/ChatCompletion'
          type: array
          title: Data
          description: Stored chat completions.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      title: ChatCompletionList
      description: Paginated list of stored chat completions.
    ChatCompletionMessage:
      additionalProperties: true
      type: object
    ChatCompletionMessageCustomToolCall:
      properties:
        type:
          type: string
          const: custom
          title: Type
          description: Tool type. Always `custom`. UNSUPPORTED on this implementation.
        custom:
          $ref: '#/components/schemas/stdapi__types__openai_chat_completions__CustomTool'
          description: The custom tool that the model called. UNSUPPORTED on this
            implementation.
        id:
          type: string
          title: Id
          description: The ID of the tool call.
      type: object
      required:
      - type
      - custom
      - id
      title: ChatCompletionMessageCustomToolCall
      description: 'Assistant tool call for a custom tool.


        UNSUPPORTED on this implementation.'
    ChatCompletionMessageFunctionToolCall:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: Tool type. Always `function`.
        function:
          $ref: '#/components/schemas/FunctionCall'
          description: The function that the model called.
        id:
          type: string
          title: Id
          description: The ID of the tool call.
      type: object
      required:
      - type
      - function
      - id
      title: ChatCompletionMessageFunctionToolCall
      description: Assistant tool call for a function tool.
    ChatCompletionNamedToolChoiceCustomParam:
      properties:
        type:
          type: string
          const: custom
          title: Type
          description: Tool type. Always `custom`. UNSUPPORTED on this implementation.
        custom:
          $ref: '#/components/schemas/CustomToolChoice'
          description: Custom tool to call by name. UNSUPPORTED on this implementation.
      type: object
      required:
      - type
      - custom
      title: ChatCompletionNamedToolChoiceCustomParam
      description: 'Named tool choice for custom tools.


        UNSUPPORTED on this implementation.'
    ChatCompletionNamedToolChoiceParam:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: For function calling, the type is always `function`.
        function:
          $ref: '#/components/schemas/FunctionToolChoiceParam'
      type: object
      required:
      - type
      - function
      title: ChatCompletionNamedToolChoiceParam
      description: Named tool choice for function tools.
    ChatCompletionPredictionContentParam:
      properties:
        type:
          type: string
          const: content
          title: Type
          description: The type of the predicted content. Always `content`.
        content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          title: Content
          description: Content to match for predicted output. If generated tokens
            match this, response returns quickly.
      type: object
      required:
      - type
      - content
      title: ChatCompletionPredictionContentParam
      description: Predicted content hint to speed up responses.
    ChatCompletionStoreMessageList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          type: array
          title: Data
          description: Input messages of the stored chat completion.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      title: ChatCompletionStoreMessageList
      description: Paginated list of the input messages of a stored chat completion.
    ChatCompletionStreamOptionsParam:
      properties:
        include_usage:
          type: boolean
          title: Include Usage
          description: 'If true, streams a usage chunk before `data: [DONE]` with
            token statistics. The `choices` field will be empty. Other chunks include
            a null usage field.'
          default: false
        include_obfuscation:
          type: boolean
          title: Include Obfuscation
          description: Enable stream obfuscation to normalize payload sizes for security.
            Adds overhead to the data stream; set to false to optimize bandwidth.
          default: false
      type: object
      title: ChatCompletionStreamOptionsParam
      description: Options for streaming responses.
    ChatCompletionSystemMessageParam:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Optional participant name to differentiate same-role participants.
            Accepted and ignored on Amazon Bedrock Converse models, whose messages
            carry no author field; forwarded on Bedrock Mantle passthrough models.
        role:
          type: string
          const: system
          title: Role
          description: Message author role. Always `system`.
        content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          title: Content
          description: System message content.
      type: object
      required:
      - role
      - content
      title: ChatCompletionSystemMessageParam
      description: System role message.
    ChatCompletionTokenLogprob:
      properties:
        token:
          type: string
          title: Token
          description: The token.
        bytes:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Bytes
          description: UTF-8 byte representation of the token. Can be null if unavailable.
        logprob:
          type: number
          title: Logprob
          description: Log probability if in top 20 tokens, otherwise -9999.0.
        top_logprobs:
          items:
            $ref: '#/components/schemas/TopLogprob'
          type: array
          title: Top Logprobs
          description: List of the most likely tokens and their log probability, at
            this token position. In rare cases, there may be fewer than the number
            of requested `top_logprobs` returned.
      additionalProperties: false
      type: object
      required:
      - token
      - logprob
      - top_logprobs
      title: ChatCompletionTokenLogprob
      description: Chat completion token log probability information.
    ChatCompletionToolMessageParam:
      properties:
        role:
          type: string
          const: tool
          title: Role
          description: Message author role. Always `tool`.
        content:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          title: Content
          description: Text content or list of text parts.
        tool_call_id:
          type: string
          title: Tool Call Id
          description: Tool call this message responds to.
      type: object
      required:
      - role
      - content
      - tool_call_id
      title: ChatCompletionToolMessageParam
      description: Tool role message.
    ChatCompletionUpdateParams:
      properties:
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Key-value pairs replacing the stored chat completion's metadata;
            `null` clears it.
      type: object
      required:
      - metadata
      title: ChatCompletionUpdateParams
      description: Request body for updating a stored chat completion.
    ChatCompletionUserMessageParam:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Optional participant name to differentiate same-role participants.
            Accepted and ignored on Amazon Bedrock Converse models, whose messages
            carry no author field; forwarded on Bedrock Mantle passthrough models.
        role:
          type: string
          const: user
          title: Role
          description: Message author role. Always `user`.
        content:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ChatCompletionContentPartTextParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartImageParam'
              - $ref: '#/components/schemas/ChatCompletionContentPartInputAudioParam'
              - $ref: '#/components/schemas/File'
              discriminator:
                propertyName: type
                mapping:
                  file: '#/components/schemas/File'
                  image_url: '#/components/schemas/ChatCompletionContentPartImageParam'
                  input_audio: '#/components/schemas/ChatCompletionContentPartInputAudioParam'
                  text: '#/components/schemas/ChatCompletionContentPartTextParam'
            type: array
          title: Content
          description: User message content.
      type: object
      required:
      - role
      - content
      title: ChatCompletionUserMessageParam
      description: User role message.
    ChatMessage:
      properties:
        role:
          type: string
          enum:
          - system
          - user
          - assistant
          - tool
          title: Role
          description: Author of the message.
        content:
          type: string
          title: Content
          description: Message text content.
          default: ''
        thinking:
          anyOf:
          - type: string
          - type: 'null'
          title: Thinking
          description: Thinking text this assistant message came with.
        images:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Images
          description: Images for multimodal models, base64-encoded or as a URL. Honored
            on a `user` or `tool` message; UNSUPPORTED on a `system` or `assistant`
            message, where they are accepted and ignored because the backend carries
            no image in those turns.
        tool_calls:
          anyOf:
          - items:
              $ref: '#/components/schemas/RequestToolCall'
            type: array
          - type: 'null'
          title: Tool Calls
          description: Tool calls this assistant message requested.
        tool_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Tool Name
          description: Name of the tool a `tool` message answers.
        tool_call_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tool Call Id
          description: Identifier of the tool call a `tool` message answers.
      type: object
      required:
      - role
      title: ChatMessage
      description: One message of the conversation.
    ChatModeration:
      properties:
        input:
          $ref: '#/components/schemas/ChatModerationResults'
          description: Moderation results for the request input.
        output:
          $ref: '#/components/schemas/ChatModerationResults'
          description: Moderation results for the generated output.
      additionalProperties: false
      type: object
      required:
      - input
      - output
      title: ChatModeration
      description: Moderation results for the request input and generated output.
    ChatModerationResults:
      properties:
        type:
          type: string
          const: moderation_results
          title: Type
          description: The object type, which is always `moderation_results`.
          default: moderation_results
        model:
          type: string
          title: Model
          description: The moderation model used to generate the results.
        results:
          items:
            $ref: '#/components/schemas/ModerationResult'
          type: array
          title: Results
          description: A list of moderation results.
      additionalProperties: false
      type: object
      required:
      - model
      - results
      title: ChatModerationResults
      description: Successful moderation results for one direction of a chat completion.
    ChatRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name.
        format:
          anyOf:
          - type: string
            enum:
            - ''
            - json
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Format
          description: 'Structured output: `json`, or a JSON schema the answer must
            match. An empty string asks for no structured output.'
        options:
          anyOf:
          - $ref: '#/components/schemas/ModelOptions'
          - type: 'null'
          description: Runtime generation options.
        stream:
          type: boolean
          title: Stream
          description: Return a stream of partial responses.
          default: true
        think:
          anyOf:
          - type: boolean
          - type: string
            enum:
            - low
            - medium
            - high
            - max
          - type: 'null'
          title: Think
          description: Return the model's thinking separately, optionally at a chosen
            level.
        keep_alive:
          anyOf:
          - type: string
          - type: number
          - type: 'null'
          title: Keep Alive
          description: 'UNSUPPORTED, accepted and ignored: models are never resident.'
        logprobs:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Logprobs
          description: 'UNSUPPORTED: log probabilities are not available.'
        top_logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top Logprobs
          description: 'UNSUPPORTED: log probabilities are not available.'
        messages:
          items:
            $ref: '#/components/schemas/ChatMessage'
          type: array
          title: Messages
          description: Conversation history, oldest message first. Empty makes the
            model resident without generating anything.
        tools:
          anyOf:
          - items:
              $ref: '#/components/schemas/ToolDefinition'
            type: array
          - type: 'null'
          title: Tools
          description: Function tools the model may call.
      type: object
      required:
      - model
      title: ChatRequest
      description: Create a chat response request.
    ChatResponse:
      properties:
        total_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Duration
          description: Total time spent answering, in nanoseconds.
        prompt_eval_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Count
          description: Number of input tokens.
        prompt_eval_cached_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Cached Count
          description: Number of input tokens read from the cache, included in `prompt_eval_count`.
        prompt_eval_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Duration
          description: Time to the first generated token, in nanoseconds.
        eval_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eval Count
          description: Number of generated tokens.
        eval_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eval Duration
          description: Time spent generating tokens after the first, in nanoseconds.
        model:
          type: string
          title: Model
          description: Model name, as the request spelled it.
        created_at:
          type: string
          title: Created At
          description: Creation timestamp, ISO 8601.
        message:
          $ref: '#/components/schemas/ResponseMessage'
          description: Assistant message.
        done:
          type: boolean
          title: Done
          description: Whether the response is complete.
        done_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Done Reason
          description: 'Why generation stopped: `stop` or `length`.'
      additionalProperties: false
      type: object
      required:
      - model
      - created_at
      - message
      - done
      title: ChatResponse
      description: Chat response, and the terminal event of a chat stream.
    Choice:
      properties:
        index:
          type: integer
          minimum: 0.0
          title: Index
          description: Index of the choice in the list of choices.
        finish_reason:
          anyOf:
          - type: string
            enum:
            - stop
            - length
            - tool_calls
            - content_filter
            - function_call
          - type: 'null'
          title: Finish Reason
          description: 'Reason the model stopped: `stop`, `length`, `content_filter`,
            `tool_calls`, or `function_call` (deprecated).'
        logprobs:
          anyOf:
          - $ref: '#/components/schemas/ChoiceLogprobs'
          - type: 'null'
          description: Log probability information for the choice.
        message:
          $ref: '#/components/schemas/ChatCompletionMessage'
          description: Assistant message.
      additionalProperties: false
      type: object
      required:
      - index
      - message
      title: Choice
      description: Non-streaming choice element for ChatCompletion.
    ChoiceLogprobs:
      properties:
        content:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionTokenLogprob'
            type: array
          - type: 'null'
          title: Content
          description: A list of message content tokens with log probability information.
        refusal:
          anyOf:
          - items:
              $ref: '#/components/schemas/ChatCompletionTokenLogprob'
            type: array
          - type: 'null'
          title: Refusal
          description: A list of message refusal tokens with log probability information.
      additionalProperties: false
      type: object
      title: ChoiceLogprobs
      description: Log probability information for the choice.
    ChunkingStrategyVadConfig:
      properties:
        type:
          type: string
          const: server_vad
          title: Type
          description: Must be set to `server_vad` to enable manual chunking using
            server side VAD.
        prefix_padding_ms:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Prefix Padding Ms
          description: Amount of audio to include before the VAD detected speech (in
            milliseconds).
        silence_duration_ms:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Silence Duration Ms
          description: Duration of silence to detect speech stop (in milliseconds).
            Shorter values respond faster but may cut in on short pauses.
        threshold:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Threshold
          description: Sensitivity threshold (0.0 to 1.0) for voice activity detection.
            Higher values require louder audio to activate.
      type: object
      required:
      - type
      title: ChunkingStrategyVadConfig
      description: Manual server-side VAD chunking configuration.
    CitationCharLocation:
      properties:
        type:
          type: string
          const: char_location
          title: Type
          description: Citation type.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        end_char_index:
          type: integer
          title: End Char Index
          description: End character index.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: File ID.
        start_char_index:
          type: integer
          title: Start Char Index
          description: Start character index.
      additionalProperties: false
      type: object
      required:
      - type
      - cited_text
      - document_index
      - end_char_index
      - start_char_index
      title: CitationCharLocation
      description: Character location citation.
    CitationCharLocationParam:
      properties:
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        end_char_index:
          type: integer
          title: End Char Index
          description: End character index.
        start_char_index:
          type: integer
          title: Start Char Index
          description: Start character index.
        type:
          type: string
          const: char_location
          title: Type
          description: Type discriminator.
      type: object
      required:
      - cited_text
      - document_index
      - end_char_index
      - start_char_index
      - type
      title: CitationCharLocationParam
      description: Citation char location parameter.
    CitationContentBlockLocation:
      properties:
        type:
          type: string
          const: content_block_location
          title: Type
          description: Citation type.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        end_block_index:
          type: integer
          title: End Block Index
          description: End content block index.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: File ID.
        start_block_index:
          type: integer
          title: Start Block Index
          description: Start content block index.
      additionalProperties: false
      type: object
      required:
      - type
      - cited_text
      - document_index
      - end_block_index
      - start_block_index
      title: CitationContentBlockLocation
      description: Content block location citation.
    CitationContentBlockLocationParam:
      properties:
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        end_block_index:
          type: integer
          title: End Block Index
          description: End content block index.
        start_block_index:
          type: integer
          title: Start Block Index
          description: Start content block index.
        type:
          type: string
          const: content_block_location
          title: Type
          description: Type discriminator.
      type: object
      required:
      - cited_text
      - document_index
      - end_block_index
      - start_block_index
      - type
      title: CitationContentBlockLocationParam
      description: Citation content block location parameter.
    CitationPageLocation:
      properties:
        type:
          type: string
          const: page_location
          title: Type
          description: Citation type.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        end_page_number:
          type: integer
          title: End Page Number
          description: End page number.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: File ID.
        start_page_number:
          type: integer
          title: Start Page Number
          description: Start page number.
      additionalProperties: false
      type: object
      required:
      - type
      - cited_text
      - document_index
      - end_page_number
      - start_page_number
      title: CitationPageLocation
      description: Page location citation.
    CitationPageLocationParam:
      properties:
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        document_index:
          type: integer
          title: Document Index
          description: Index of the cited document.
        document_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Title
          description: Title of the cited document.
        end_page_number:
          type: integer
          title: End Page Number
          description: End page number.
        start_page_number:
          type: integer
          title: Start Page Number
          description: Start page number.
        type:
          type: string
          const: page_location
          title: Type
          description: Type discriminator.
      type: object
      required:
      - cited_text
      - document_index
      - end_page_number
      - start_page_number
      - type
      title: CitationPageLocationParam
      description: Citation page location parameter.
    CitationSearchResultLocationParam:
      properties:
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        end_block_index:
          type: integer
          title: End Block Index
          description: End content block index.
        search_result_index:
          type: integer
          title: Search Result Index
          description: Index of the search result.
        source:
          type: string
          title: Source
          description: Source of the search result.
        start_block_index:
          type: integer
          title: Start Block Index
          description: Start content block index.
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Title.
        type:
          type: string
          const: search_result_location
          title: Type
          description: Type discriminator.
      type: object
      required:
      - cited_text
      - end_block_index
      - search_result_index
      - source
      - start_block_index
      - type
      title: CitationSearchResultLocationParam
      description: Citation search result location parameter.
    CitationWebSearchResultLocationParam:
      properties:
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        encrypted_index:
          type: string
          title: Encrypted Index
          description: Encrypted index for the search result.
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Title.
        type:
          type: string
          const: web_search_result_location
          title: Type
          description: Type discriminator.
        url:
          type: string
          title: Url
          description: URL.
      type: object
      required:
      - cited_text
      - encrypted_index
      - type
      - url
      title: CitationWebSearchResultLocationParam
      description: Citation web search result location parameter.
    CitationsConfig:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether the feature is enabled.
      additionalProperties: false
      type: object
      required:
      - enabled
      title: CitationsConfig
      description: Citations config.
    CitationsConfigParam:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether to enable citations.
      type: object
      required:
      - enabled
      title: CitationsConfigParam
      description: Citations config parameter.
    CitationsSearchResultLocation:
      properties:
        type:
          type: string
          const: search_result_location
          title: Type
          description: Citation type.
        search_result_index:
          type: integer
          title: Search Result Index
          description: Index of the search result.
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        end_block_index:
          type: integer
          title: End Block Index
          description: End content block index.
        source:
          type: string
          title: Source
          description: Source of the search result.
        start_block_index:
          type: integer
          title: Start Block Index
          description: Start content block index.
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Title.
      additionalProperties: false
      type: object
      required:
      - type
      - search_result_index
      - cited_text
      - end_block_index
      - source
      - start_block_index
      title: CitationsSearchResultLocation
      description: Search result citation location.
    CitationsWebSearchResultLocation:
      properties:
        type:
          type: string
          const: web_search_result_location
          title: Type
          description: Citation type.
        url:
          type: string
          title: Url
          description: URL of the web search result.
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Title of the web search result.
        cited_text:
          type: string
          title: Cited Text
          description: Cited text content.
        encrypted_index:
          type: string
          title: Encrypted Index
          description: Encrypted index for the search result.
      additionalProperties: false
      type: object
      required:
      - type
      - url
      - cited_text
      - encrypted_index
      title: CitationsWebSearchResultLocation
      description: Web search result citation location.
    ClearThinking20251015EditParam:
      properties:
        type:
          type: string
          const: clear_thinking_20251015
          title: Type
          description: Edit type.
        keep:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ThinkingTurnsParam'
            - $ref: '#/components/schemas/AllThinkingTurnsParam'
            discriminator:
              propertyName: type
              mapping:
                all: '#/components/schemas/AllThinkingTurnsParam'
                thinking_turns: '#/components/schemas/ThinkingTurnsParam'
          - type: string
            const: all
          - type: 'null'
          title: Keep
          description: Most recent assistant turns whose thinking is kept; the default
            depends on the model.
      type: object
      required:
      - type
      title: ClearThinking20251015EditParam
      description: 'Clear the thinking blocks of older assistant turns.


        Requires thinking enabled or adaptive, and must be the first edit.'
    ClearThinking20251015EditResponse:
      properties:
        type:
          type: string
          const: clear_thinking_20251015
          title: Type
          description: Edit type.
        cleared_input_tokens:
          type: integer
          title: Cleared Input Tokens
          description: Input tokens cleared by the edit.
        cleared_thinking_turns:
          type: integer
          title: Cleared Thinking Turns
          description: Assistant turns whose thinking was cleared.
      type: object
      required:
      - type
      - cleared_input_tokens
      - cleared_thinking_turns
      title: ClearThinking20251015EditResponse
      description: A thinking clearing edit applied to the prompt.
    ClearToolUses20250919EditParam:
      properties:
        type:
          type: string
          const: clear_tool_uses_20250919
          title: Type
          description: Edit type.
        trigger:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/InputTokensTriggerParam'
            - $ref: '#/components/schemas/ToolUsesTriggerParam'
            discriminator:
              propertyName: type
              mapping:
                input_tokens: '#/components/schemas/InputTokensTriggerParam'
                tool_uses: '#/components/schemas/ToolUsesTriggerParam'
          - type: 'null'
          title: Trigger
          description: When to clear; defaults to 100,000 input tokens.
        keep:
          anyOf:
          - $ref: '#/components/schemas/ToolUsesKeepParam'
          - type: 'null'
          description: Most recent tool uses left untouched; defaults to 3.
        clear_at_least:
          anyOf:
          - $ref: '#/components/schemas/InputTokensClearAtLeastParam'
          - type: 'null'
          description: Clear only when at least this many input tokens can be removed.
        exclude_tools:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Exclude Tools
          description: Tool names whose uses are never cleared.
        clear_tool_inputs:
          anyOf:
          - type: boolean
          - items:
              type: string
            type: array
          - type: 'null'
          title: Clear Tool Inputs
          description: 'Also clear the tool call inputs: all of them, or those of
            the named tools.'
      type: object
      required:
      - type
      title: ClearToolUses20250919EditParam
      description: Clear the oldest tool results once the context grows past a trigger.
    ClearToolUses20250919EditResponse:
      properties:
        type:
          type: string
          const: clear_tool_uses_20250919
          title: Type
          description: Edit type.
        cleared_input_tokens:
          type: integer
          title: Cleared Input Tokens
          description: Input tokens cleared by the edit.
        cleared_tool_uses:
          type: integer
          title: Cleared Tool Uses
          description: Tool uses cleared by the edit.
      type: object
      required:
      - type
      - cleared_input_tokens
      - cleared_tool_uses
      title: ClearToolUses20250919EditResponse
      description: A tool-result clearing edit applied to the prompt.
    ClientSecretCreateParams:
      properties:
        expires_after:
          anyOf:
          - $ref: '#/components/schemas/ClientSecretExpiresAfter'
          - type: 'null'
          description: Lifetime of the minted secret.
        session:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/RealtimeSessionConfig'
            - $ref: '#/components/schemas/TranscriptionSessionConfig'
            discriminator:
              propertyName: type
              mapping:
                realtime: '#/components/schemas/RealtimeSessionConfig'
                transcription: '#/components/schemas/TranscriptionSessionConfig'
          - type: 'null'
          title: Session
          description: Session configuration the secret carries, applied to every
            session opened with it; a session may still override it.
      type: object
      title: ClientSecretCreateParams
      description: Request body of the client secret creation route.
    ClientSecretCreateResponse:
      properties:
        value:
          type: string
          title: Value
          description: The client secret to connect with.
        expires_at:
          type: integer
          title: Expires At
          description: Unix time, in seconds, after which the secret is refused.
        session:
          oneOf:
          - $ref: '#/components/schemas/RealtimeSessionConfig'
          - $ref: '#/components/schemas/TranscriptionSessionConfig'
          title: Session
          description: Session configuration it carries.
          discriminator:
            propertyName: type
            mapping:
              realtime: '#/components/schemas/RealtimeSessionConfig'
              transcription: '#/components/schemas/TranscriptionSessionConfig'
      additionalProperties: false
      type: object
      required:
      - value
      - expires_at
      - session
      title: ClientSecretCreateResponse
      description: A minted ephemeral client secret and the session it opens.
    ClientSecretExpiresAfter:
      properties:
        anchor:
          type: string
          const: created_at
          title: Anchor
          description: Moment the lifetime is counted from.
          default: created_at
        seconds:
          type: integer
          maximum: 7200.0
          minimum: 10.0
          title: Seconds
          description: Seconds the secret stays usable for.
          default: 600
      type: object
      title: ClientSecretExpiresAfter
      description: When a minted client secret stops being usable.
    CodeExecutionOutputBlock:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: code_execution_output
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - file_id
      - type
      title: CodeExecutionOutputBlock
      description: Code execution output block.
    CodeExecutionOutputBlockParam:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: code_execution_output
          title: Type
          description: Type discriminator.
      type: object
      required:
      - file_id
      - type
      title: CodeExecutionOutputBlockParam
      description: Code execution output block parameter.
    CodeExecutionResultBlock:
      properties:
        content:
          items:
            $ref: '#/components/schemas/CodeExecutionOutputBlock'
          type: array
          title: Content
          description: Block content.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        stdout:
          type: string
          title: Stdout
          description: Stdout.
        type:
          type: string
          const: code_execution_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - return_code
      - stderr
      - stdout
      - type
      title: CodeExecutionResultBlock
      description: Code execution result block.
    CodeExecutionResultBlockParam:
      properties:
        content:
          items:
            $ref: '#/components/schemas/CodeExecutionOutputBlockParam'
          type: array
          title: Content
          description: Block content.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        stdout:
          type: string
          title: Stdout
          description: Stdout.
        type:
          type: string
          const: code_execution_result
          title: Type
          description: Type discriminator.
      type: object
      required:
      - content
      - return_code
      - stderr
      - stdout
      - type
      title: CodeExecutionResultBlockParam
      description: Code execution result block parameter.
    CodeExecutionToolParam:
      properties:
        name:
          type: string
          const: code_execution
          title: Name
          description: Tool name.
        type:
          type: string
          pattern: ^code_execution(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - name
      - type
      title: CodeExecutionToolParam
      description: Code execution tool parameter.
    CodeExecutionToolResultBlock:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/CodeExecutionToolResultError'
          - $ref: '#/components/schemas/CodeExecutionResultBlock'
          - $ref: '#/components/schemas/EncryptedCodeExecutionResultBlock'
          title: Content
          description: Code execution result with encrypted stdout for PFC + web_search
            results.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: code_execution_tool_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: CodeExecutionToolResultBlock
      description: Code execution tool result block.
    CodeExecutionToolResultBlockParam:
      properties:
        content:
          $ref: '#/components/schemas/CodeExecutionToolResultBlockParamContentParam'
          description: Code execution result with encrypted stdout for PFC + web_search
            results.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: code_execution_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: CodeExecutionToolResultBlockParam
      description: Code execution tool result block parameter.
    CodeExecutionToolResultBlockParamContentParam:
      anyOf:
      - $ref: '#/components/schemas/CodeExecutionToolResultErrorParam'
      - $ref: '#/components/schemas/CodeExecutionResultBlockParam'
      - $ref: '#/components/schemas/EncryptedCodeExecutionResultBlockParam'
    CodeExecutionToolResultError:
      properties:
        error_code:
          $ref: '#/components/schemas/CodeExecutionToolResultErrorCode'
          description: Error code.
        type:
          type: string
          const: code_execution_tool_result_error
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: CodeExecutionToolResultError
      description: Code execution tool result error.
    CodeExecutionToolResultErrorCode:
      type: string
      enum:
      - invalid_tool_input
      - unavailable
      - too_many_requests
      - execution_time_exceeded
    CodeExecutionToolResultErrorParam:
      properties:
        error_code:
          $ref: '#/components/schemas/CodeExecutionToolResultErrorCode'
          description: Error code.
        type:
          type: string
          const: code_execution_tool_result_error
          title: Type
          description: Type discriminator.
      type: object
      required:
      - error_code
      - type
      title: CodeExecutionToolResultErrorParam
      description: Code execution tool result error parameter.
    CodeInterpreter:
      properties:
        container:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/CodeInterpreterContainerAuto'
          - type: 'null'
          title: Container
          description: Code interpreter container (ID or config).
        type:
          type: string
          const: code_interpreter
          title: Type
          description: Code interpreter tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
      type: object
      required:
      - type
      title: CodeInterpreter
      description: A tool that runs Python code to help generate a response to a prompt.
    CodeInterpreterCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the code interpreter tool call.
        container_id:
          type: string
          title: Container Id
          description: The ID of the container used to run the code.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          - interpreting
          - failed
          title: Status
          description: The status of the code interpreter tool call.
        type:
          type: string
          const: code_interpreter_call
          title: Type
          description: The type of the code interpreter tool call. Always `code_interpreter_call`.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: The code to run, or null if not available.
        outputs:
          anyOf:
          - items:
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
            type: array
          - type: 'null'
          title: Outputs
          description: The outputs generated by the code interpreter (logs or images).
      type: object
      required:
      - id
      - container_id
      - status
      - type
      title: CodeInterpreterCallInput
      description: A tool call to run code (as input item).
    CodeInterpreterContainerAuto:
      properties:
        type:
          type: string
          const: auto
          title: Type
          description: Auto container type.
        file_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: File Ids
          description: Uploaded files for code interpreter.
        memory_limit:
          anyOf:
          - type: string
            enum:
            - 1g
            - 4g
            - 16g
            - 64g
          - type: 'null'
          title: Memory Limit
          description: Container memory limit.
        network_policy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ContainerNetworkPolicyDisabled'
            - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist'
            discriminator:
              propertyName: type
              mapping:
                allowlist: '#/components/schemas/ContainerNetworkPolicyAllowlist'
                disabled: '#/components/schemas/ContainerNetworkPolicyDisabled'
          - type: 'null'
          title: Network Policy
          description: Network access policy.
      type: object
      required:
      - type
      title: CodeInterpreterContainerAuto
      description: Configuration for a code interpreter container.
    CodeInterpreterOutputImage:
      properties:
        type:
          type: string
          const: image
          title: Type
          description: Image output type.
        url:
          type: string
          title: Url
          description: Image output URL.
      additionalProperties: false
      type: object
      required:
      - type
      - url
      title: CodeInterpreterOutputImage
      description: The image output from the code interpreter.
    CodeInterpreterOutputLogs:
      properties:
        logs:
          type: string
          title: Logs
          description: Code interpreter logs.
        type:
          type: string
          const: logs
          title: Type
          description: Logs output type.
      additionalProperties: false
      type: object
      required:
      - logs
      - type
      title: CodeInterpreterOutputLogs
      description: The logs output from the code interpreter.
    CodeInterpreterSessionsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        object:
          type: string
          const: organization.usage.code_interpreter_sessions.result
          title: Object
          default: organization.usage.code_interpreter_sessions.result
        num_sessions:
          type: integer
          title: Num Sessions
          description: Number of sessions.
          default: 0
      additionalProperties: false
      type: object
      title: CodeInterpreterSessionsResult
      description: Aggregated code interpreter sessions of one time bucket.
    CompactParams:
      properties:
        model:
          type: string
          title: Model
          description: Model ID. Wildcard patterns are accepted and select the most
            recent matching model.
        input:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Input'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Input'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Input
          description: Conversation inputs to compact.
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
          description: System message inserted into the model's context.
        previous_response_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Response Id
          description: ID of a stored response whose conversation is compacted along
            with the new input.
        prompt_cache_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Cache Key
          description: Cache key for similar requests.
        prompt_cache_options:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_responses__PromptCacheOptions'
          - type: 'null'
          description: Explicit prompt-caching configuration.
        prompt_cache_retention:
          anyOf:
          - type: string
            enum:
            - in_memory
            - 24h
            - 1h
            - 5m
          - type: 'null'
          title: Prompt Cache Retention
          description: Cache retention policy.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - ultrafast
          - type: 'null'
          title: Service Tier
          description: 'Processing tier: `priority` (lowest, most consistent latency;
            `fast` is an alias), `flex` (cost-efficient); any other value is served
            on the standard tier.'
      type: object
      required:
      - model
      title: CompactParams
      description: 'Request body for POST /v1/responses/compact.


        Compacts a conversation into a single ``compaction`` item that later

        requests can send back as input.'
    CompactedResponse:
      properties:
        id:
          type: string
          title: Id
          description: Compacted response ID.
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (in seconds) when the compaction was created.
        object:
          type: string
          const: response.compaction
          title: Object
          description: The object type, which is always `response.compaction`.
          default: response.compaction
        output:
          items:
            anyOf:
            - $ref: '#/components/schemas/CompactionUserMessage'
            - $ref: '#/components/schemas/ResponseCompactionItem'
          type: array
          title: Output
          description: The conversation's user messages followed by the compaction
            item.
        usage:
          $ref: '#/components/schemas/ResponseUsage'
          description: Token usage of the compaction request.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - output
      - usage
      title: CompactedResponse
      description: Response body for POST /v1/responses/compact.
    CompactionItemParam:
      properties:
        encrypted_content:
          type: string
          title: Encrypted Content
          description: The encrypted content of the compaction summary.
        type:
          type: string
          const: compaction
          title: Type
          description: The type of the item. Always `compaction`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The ID of the compaction item.
      type: object
      required:
      - encrypted_content
      - type
      title: CompactionItemParam
      description: A compaction item generated by the v1/responses/compact API.
    CompactionTrigger:
      properties:
        type:
          type: string
          const: compaction_trigger
          title: Type
          description: The type of the item. Always `compaction_trigger`.
      type: object
      required:
      - type
      title: CompactionTrigger
      description: Compacts the current context. Must be the final input item.
    CompactionUserMessage:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the echoed message.
        type:
          type: string
          const: message
          title: Type
          description: The item type, which is always `message`.
          default: message
        status:
          type: string
          const: completed
          title: Status
          description: The item status, which is always `completed`.
          default: completed
        role:
          type: string
          const: user
          title: Role
          description: The message role, which is always `user`.
          default: user
        content:
          items:
            additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          type: array
          title: Content
          description: The message content parts (e.g. `input_text`).
      additionalProperties: false
      type: object
      required:
      - id
      - content
      title: CompactionUserMessage
      description: A user message echoed in the compacted output.
    ComparisonFilter-Output:
      properties:
        key:
          type: string
          title: Key
          description: The key to compare against.
        type:
          type: string
          enum:
          - eq
          - ne
          - gt
          - gte
          - lt
          - lte
          - in
          - nin
          title: Type
          description: 'Comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`,
            `in`, or `nin`.'
        value:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - items:
              anyOf:
              - type: string
              - type: number
            type: array
          title: Value
          description: The value to compare against the key.
      type: object
      required:
      - key
      - type
      - value
      title: ComparisonFilter
      description: Compares a specified attribute key to a given value using a defined
        operator.
    CompleteUploadBody:
      properties:
        part_ids:
          items:
            type: string
            pattern: ^part_[0-9a-f]{32}$
          type: array
          title: Part Ids
          description: The ordered list of Part IDs.
        md5:
          anyOf:
          - type: string
            pattern: ^[0-9a-fA-F]{32}$
          - type: 'null'
          title: Md5
          description: Hex-encoded md5 digest of the whole file contents, i.e. of
            the parts concatenated in `part_ids` order. When set, the completed file
            is verified against it and a mismatch is rejected.
      type: object
      required:
      - part_ids
      title: CompleteUploadBody
      description: Request body for ``POST /v1/uploads/{upload_id}/complete``.
    Completion:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the completion.
        object:
          type: string
          const: text_completion
          title: Object
          description: The object type, always ``text_completion``.
          default: text_completion
        created:
          type: integer
          title: Created
          description: Unix timestamp (in seconds) when the completion was created.
        model:
          type: string
          title: Model
          description: The model used to generate the completion.
        choices:
          items:
            $ref: '#/components/schemas/CompletionChoice'
          type: array
          title: Choices
          description: The list of generated completion choices.
        usage:
          anyOf:
          - $ref: '#/components/schemas/CompletionUsage'
          - type: 'null'
          description: Usage statistics for the completion request.
        system_fingerprint:
          anyOf:
          - type: string
          - type: 'null'
          title: System Fingerprint
          description: Backend configuration fingerprint that the model ran with.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - reserved
          - type: 'null'
          title: Service Tier
          description: Processing tier used to serve the request.
      additionalProperties: false
      type: object
      required:
      - id
      - created
      - model
      title: Completion
      description: Response for the OpenAI completions API (``POST /v1/completions``).
    CompletionChoice:
      properties:
        text:
          type: string
          title: Text
          description: The generated text for this choice.
        index:
          type: integer
          minimum: 0.0
          title: Index
          description: The index of this choice in the list of choices.
          default: 0
        finish_reason:
          anyOf:
          - type: string
            enum:
            - stop
            - length
            - content_filter
          - type: 'null'
          title: Finish Reason
          description: The reason the model stopped generating text.
        logprobs:
          anyOf:
          - $ref: '#/components/schemas/CompletionLogprobs'
          - type: 'null'
          description: Log probability information for this choice.
      additionalProperties: false
      type: object
      required:
      - text
      title: CompletionChoice
      description: A single completion choice.
    CompletionLogprobs:
      properties:
        tokens:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tokens
          description: The tokens chosen by the model.
        token_logprobs:
          anyOf:
          - items:
              type: number
            type: array
          - type: 'null'
          title: Token Logprobs
          description: Log probabilities of each token.
        top_logprobs:
          anyOf:
          - items:
              additionalProperties:
                type: number
              type: object
            type: array
          - type: 'null'
          title: Top Logprobs
          description: Top log probabilities for each token.
        text_offset:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Text Offset
          description: Character offsets into the prompt text.
      additionalProperties: false
      type: object
      title: CompletionLogprobs
      description: 'Log probability information for a completion choice.


        Always returned as ``None`` — the backend does not surface logprob data.'
    CompletionTokensDetails:
      properties:
        accepted_prediction_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Accepted Prediction Tokens
          description: Predicted tokens that appeared in the completion (Predicted
            Outputs).
        audio_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Audio Tokens
          description: Audio input tokens generated by the model.
        reasoning_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Reasoning Tokens
          description: Tokens generated for reasoning.
        rejected_prediction_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Rejected Prediction Tokens
          description: Predicted tokens that did not appear in the completion. Counted
            for billing and context limits.
      additionalProperties: false
      type: object
      title: CompletionTokensDetails
      description: Breakdown of tokens used in a completion.
    CompletionUsage:
      properties:
        prompt_tokens:
          type: integer
          title: Prompt Tokens
          description: Number of tokens in the prompt.
        completion_tokens:
          type: integer
          title: Completion Tokens
          description: Number of tokens in the generated completion.
        total_tokens:
          type: integer
          title: Total Tokens
          description: Total number of tokens used in the request (prompt + completion).
        completion_tokens_details:
          anyOf:
          - $ref: '#/components/schemas/CompletionTokensDetails'
          - type: 'null'
          description: Breakdown of tokens used in a completion.
        prompt_tokens_details:
          anyOf:
          - $ref: '#/components/schemas/PromptTokensDetails'
          - type: 'null'
          description: Breakdown of tokens used in the prompt.
      additionalProperties: false
      type: object
      required:
      - prompt_tokens
      - completion_tokens
      - total_tokens
      title: CompletionUsage
      description: Token usage statistics, compatible with OpenAI.
    CompletionsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.completions.result
          title: Object
          default: organization.usage.completions.result
        input_tokens:
          type: integer
          title: Input Tokens
          description: Input tokens, cached and cache-write tokens included.
          default: 0
        output_tokens:
          type: integer
          title: Output Tokens
          description: Output tokens.
          default: 0
        input_cached_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Input Cached Tokens
          description: Input tokens read from the prompt cache.
        input_cache_write_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Input Cache Write Tokens
          description: Input tokens written to the prompt cache.
        input_uncached_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Input Uncached Tokens
          description: Input tokens that were not read from the cache.
        batch:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Batch
          description: Set when grouping by batch.
        service_tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Service Tier
          description: Set when grouping by service_tier.
      additionalProperties: false
      type: object
      title: CompletionsResult
      description: Aggregated completions usage of one time bucket.
    CompoundFilter-Output:
      properties:
        filters:
          items:
            anyOf:
            - $ref: '#/components/schemas/ComparisonFilter-Output'
            - {}
          type: array
          title: Filters
          description: Array of filters to combine.
        type:
          type: string
          enum:
          - and
          - or
          title: Type
          description: 'Combine operation: `and` or `or`.'
      type: object
      required:
      - filters
      - type
      title: CompoundFilter
      description: Combine multiple filters using `and` or `or`.
    ComputerActionClick:
      properties:
        button:
          type: string
          enum:
          - left
          - right
          - wheel
          - back
          - forward
          title: Button
          description: Mouse button pressed.
        type:
          type: string
          const: click
          title: Type
          description: Click action type.
        x:
          type: integer
          title: X
          description: Click x-coordinate.
        y:
          type: integer
          title: Y
          description: Click y-coordinate.
        keys:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keys
          description: Keys held while clicking.
      additionalProperties: false
      type: object
      required:
      - button
      - type
      - x
      - y
      title: ComputerActionClick
      description: A click action.
    ComputerActionDoubleClick:
      properties:
        type:
          type: string
          const: double_click
          title: Type
          description: Double click action type.
        x:
          type: integer
          title: X
          description: Double click x-coordinate.
        y:
          type: integer
          title: Y
          description: Double click y-coordinate.
        keys:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keys
          description: Keys held while double-clicking.
      additionalProperties: false
      type: object
      required:
      - type
      - x
      - y
      title: ComputerActionDoubleClick
      description: A double click action.
    ComputerActionDrag:
      properties:
        path:
          items:
            $ref: '#/components/schemas/ComputerActionDragPath'
          type: array
          title: Path
          description: Drag path coordinates.
        type:
          type: string
          const: drag
          title: Type
          description: Drag action type.
        keys:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keys
          description: Keys held while dragging.
      additionalProperties: false
      type: object
      required:
      - path
      - type
      title: ComputerActionDrag
      description: A drag action.
    ComputerActionDragPath:
      properties:
        x:
          type: integer
          title: X
          description: X-coordinate.
        y:
          type: integer
          title: Y
          description: Y-coordinate.
      additionalProperties: false
      type: object
      required:
      - x
      - y
      title: ComputerActionDragPath
      description: An x/y coordinate pair.
    ComputerActionKeypress:
      properties:
        keys:
          items:
            type: string
          type: array
          title: Keys
          description: Keys to press.
        type:
          type: string
          const: keypress
          title: Type
          description: Keypress action type.
      additionalProperties: false
      type: object
      required:
      - keys
      - type
      title: ComputerActionKeypress
      description: A collection of keypresses.
    ComputerActionMove:
      properties:
        type:
          type: string
          const: move
          title: Type
          description: Move action type.
        x:
          type: integer
          title: X
          description: Target x-coordinate.
        y:
          type: integer
          title: Y
          description: Target y-coordinate.
        keys:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keys
          description: Keys held while moving.
      additionalProperties: false
      type: object
      required:
      - type
      - x
      - y
      title: ComputerActionMove
      description: A mouse move action.
    ComputerActionScreenshot:
      properties:
        type:
          type: string
          const: screenshot
          title: Type
          description: Screenshot action type.
      additionalProperties: false
      type: object
      required:
      - type
      title: ComputerActionScreenshot
      description: A screenshot action.
    ComputerActionScroll:
      properties:
        scroll_x:
          type: integer
          title: Scroll X
          description: Horizontal scroll distance.
        scroll_y:
          type: integer
          title: Scroll Y
          description: Vertical scroll distance.
        type:
          type: string
          const: scroll
          title: Type
          description: Scroll action type.
        x:
          type: integer
          title: X
          description: Scroll x-coordinate.
        y:
          type: integer
          title: Y
          description: Scroll y-coordinate.
        keys:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keys
          description: Keys held while scrolling.
      additionalProperties: false
      type: object
      required:
      - scroll_x
      - scroll_y
      - type
      - x
      - y
      title: ComputerActionScroll
      description: A scroll action.
    ComputerActionType:
      properties:
        text:
          type: string
          title: Text
          description: Text to type.
        type:
          type: string
          const: type
          title: Type
          description: Type action type.
      additionalProperties: false
      type: object
      required:
      - text
      - type
      title: ComputerActionType
      description: An action to type in text.
    ComputerActionWait:
      properties:
        type:
          type: string
          const: wait
          title: Type
          description: Wait action type.
      additionalProperties: false
      type: object
      required:
      - type
      title: ComputerActionWait
      description: A wait action.
    ComputerCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the computer call.
        call_id:
          type: string
          title: Call Id
          description: An identifier used when responding to the tool call with output.
        pending_safety_checks:
          items:
            additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          type: array
          title: Pending Safety Checks
          description: The pending safety checks for the computer call.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the item.
        type:
          type: string
          const: computer_call
          title: Type
          description: The type of the computer call. Always `computer_call`.
        action:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Action
          description: The action to perform.
        actions:
          anyOf:
          - items:
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
            type: array
          - type: 'null'
          title: Actions
          description: Flattened batched actions for `computer_use`.
      type: object
      required:
      - id
      - call_id
      - pending_safety_checks
      - status
      - type
      title: ComputerCallInput
      description: A tool call to a computer use tool (as input item).
    ComputerCallOutput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: Computer tool call ID.
        output:
          $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot'
          description: Computer screenshot.
        type:
          type: string
          const: computer_call_output
          title: Type
          description: Computer call output type.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Output ID.
        acknowledged_safety_checks:
          anyOf:
          - items:
              $ref: '#/components/schemas/ComputerCallOutputAcknowledgedSafetyCheck'
            type: array
          - type: 'null'
          title: Acknowledged Safety Checks
          description: Acknowledged safety checks.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: 'Status: `in_progress`, `completed`, or `incomplete`.'
      type: object
      required:
      - call_id
      - output
      - type
      title: ComputerCallOutput
      description: The output of a computer tool call.
    ComputerCallOutputAcknowledgedSafetyCheck:
      properties:
        id:
          type: string
          title: Id
          description: Safety check ID.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Safety check type.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Safety check details.
      type: object
      required:
      - id
      title: ComputerCallOutputAcknowledgedSafetyCheck
      description: A pending safety check for the computer call.
    ComputerTool:
      properties:
        type:
          type: string
          const: computer
          title: Type
          description: Computer tool type.
      type: object
      required:
      - type
      title: ComputerTool
      description: 'A tool that controls a virtual computer.


        UNSUPPORTED on this implementation.'
    ComputerToolsetParam:
      properties:
        type:
          type: string
          pattern: ^computer_toolset(?:_[0-9]{8})?$
          title: Type
          description: Tool type. The dated computer toolset version, e.g. `computer_toolset_20260801`.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this tool.
        configs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/ToolsetMemberConfigParam'
            type: object
          - type: 'null'
          title: Configs
          description: Per-member configuration, keyed by member name — the same name
            that member's `tool_use` blocks carry. A member left out keeps its defaults.
      type: object
      required:
      - type
      title: ComputerToolsetParam
      description: 'Every computer tool, declared as one `tools` entry.


        The entry has no name and no schema of its own: it names the family, and

        `configs` tunes its members, zoom included.

        UNSUPPORTED except on models whose own API runs the toolset: every other

        model refuses the request rather than answer it without a desktop. The

        single-tool `computer` server tool is unaffected.'
    ComputerUsePreviewTool:
      properties:
        display_height:
          type: integer
          title: Display Height
          description: Display height in pixels.
        display_width:
          type: integer
          title: Display Width
          description: Display width in pixels.
        environment:
          type: string
          enum:
          - windows
          - mac
          - linux
          - ubuntu
          - browser
          title: Environment
          description: Computer environment to control.
        type:
          type: string
          const: computer_use_preview
          title: Type
          description: Computer use preview tool type.
      type: object
      required:
      - display_height
      - display_width
      - environment
      - type
      title: ComputerUsePreviewTool
      description: 'A tool that controls a virtual computer (preview version).


        UNSUPPORTED on this implementation.'
    ConfigurationUpdateInput:
      properties:
        type:
          type: string
          const: configuration_update
          title: Type
          description: The type of the item. Always `configuration_update`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the configuration update item.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/ConfigurationUpdateReasoningInput'
          - type: 'null'
          description: Reasoning settings recorded by this item.
        text:
          anyOf:
          - $ref: '#/components/schemas/ConfigurationUpdateTextInput'
          - type: 'null'
          description: Text output settings recorded by this item.
      type: object
      required:
      - type
      title: ConfigurationUpdateInput
      description: A response configuration change recorded in conversation history.
    ConfigurationUpdateReasoning:
      properties:
        effort:
          anyOf:
          - type: string
            enum:
            - none
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Effort
          description: Reasoning effort recorded by this item.
      additionalProperties: false
      type: object
      title: ConfigurationUpdateReasoning
      description: The reasoning settings carried by a configuration update item.
    ConfigurationUpdateReasoningInput:
      properties:
        effort:
          anyOf:
          - type: string
            enum:
            - none
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Effort
          description: 'Reasoning effort recorded by this history item. Accepted and
            ignored: a response is configured by the `reasoning` parameter of its
            own request.'
      type: object
      title: ConfigurationUpdateReasoningInput
      description: The reasoning settings carried by a configuration update item.
    ConfigurationUpdateText:
      properties:
        format:
          oneOf:
          - $ref: '#/components/schemas/ResponseFormatText'
          - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
          title: Format
          description: Output format recorded by this item.
          discriminator:
            propertyName: type
            mapping:
              json_schema: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
              text: '#/components/schemas/ResponseFormatText'
      additionalProperties: false
      type: object
      required:
      - format
      title: ConfigurationUpdateText
      description: The text output settings carried by a configuration update item.
    ConfigurationUpdateTextInput:
      properties:
        format:
          oneOf:
          - $ref: '#/components/schemas/ResponseFormatText'
          - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
          title: Format
          description: 'Output format recorded by this history item. Accepted and
            ignored: a response is configured by the `text` parameter of its own request.'
          discriminator:
            propertyName: type
            mapping:
              json_schema: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
              text: '#/components/schemas/ResponseFormatText'
      type: object
      required:
      - format
      title: ConfigurationUpdateTextInput
      description: The text output settings carried by a configuration update item.
    Container:
      properties:
        id:
          type: string
          title: Id
          description: Identifier for the container used in this request.
        expires_at:
          type: string
          title: Expires At
          description: The time at which the container will expire.
      additionalProperties: false
      type: object
      required:
      - id
      - expires_at
      title: Container
      description: Information about the container used in the request (for the code
        execution tool).
    ContainerAuto:
      properties:
        type:
          type: string
          const: container_auto
          title: Type
          description: Container auto.
        file_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: File Ids
          description: Uploaded files to make available to code.
        memory_limit:
          anyOf:
          - type: string
            enum:
            - 1g
            - 4g
            - 16g
            - 64g
          - type: 'null'
          title: Memory Limit
          description: Container memory limit.
        network_policy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ContainerNetworkPolicyDisabled'
            - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist'
            discriminator:
              propertyName: type
              mapping:
                allowlist: '#/components/schemas/ContainerNetworkPolicyAllowlist'
                disabled: '#/components/schemas/ContainerNetworkPolicyDisabled'
          - type: 'null'
          title: Network Policy
          description: Network access policy.
        skills:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/SkillReference'
              - $ref: '#/components/schemas/InlineSkill'
              discriminator:
                propertyName: type
                mapping:
                  inline: '#/components/schemas/InlineSkill'
                  skill_reference: '#/components/schemas/SkillReference'
            type: array
          - type: 'null'
          title: Skills
          description: Skills to include in the container.
      type: object
      required:
      - type
      title: ContainerAuto
      description: Automatically creates a container for this request.
    ContainerNetworkPolicyAllowlist:
      properties:
        allowed_domains:
          items:
            type: string
          type: array
          title: Allowed Domains
          description: List of allowed domains.
        type:
          type: string
          const: allowlist
          title: Type
          description: Allowlist network policy.
        domain_secrets:
          anyOf:
          - items:
              $ref: '#/components/schemas/ContainerNetworkPolicyDomainSecret'
            type: array
          - type: 'null'
          title: Domain Secrets
          description: Domain-scoped secrets for allowlisted domains.
      type: object
      required:
      - allowed_domains
      - type
      title: ContainerNetworkPolicyAllowlist
      description: Allow outbound network access only to specified domains.
    ContainerNetworkPolicyDisabled:
      properties:
        type:
          type: string
          const: disabled
          title: Type
          description: Network policy disabled.
      type: object
      required:
      - type
      title: ContainerNetworkPolicyDisabled
      description: Disable outbound network access from the container.
    ContainerNetworkPolicyDomainSecret:
      properties:
        domain:
          type: string
          title: Domain
          description: The domain for this secret.
        name:
          type: string
          title: Name
          description: The secret name.
        value:
          type: string
          title: Value
          description: The secret value.
      type: object
      required:
      - domain
      - name
      - value
      title: ContainerNetworkPolicyDomainSecret
      description: A domain-scoped secret injected for an allowlisted domain.
    ContainerParams:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Identifier of the container.
        skills:
          anyOf:
          - items:
              $ref: '#/components/schemas/SkillParams'
            type: array
          - type: 'null'
          title: Skills
          description: Skills to load in the container.
      type: object
      title: ContainerParams
      description: 'A container to reuse, and the skills to load in it.


        UNSUPPORTED on this implementation: accepted and ignored, and the rest of
        the

        request is served normally. No container is created or reused.'
    ContainerReference:
      properties:
        container_id:
          type: string
          title: Container Id
          description: Referenced container ID.
        type:
          type: string
          const: container_reference
          title: Type
          description: Container reference type.
      type: object
      required:
      - container_id
      - type
      title: ContainerReference
      description: References a container created with the /v1/containers endpoint.
    ContainerUploadBlock:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: container_upload
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - file_id
      - type
      title: ContainerUploadBlock
      description: Response model for a file uploaded to the container.
    ContainerUploadBlockParam:
      properties:
        file_id:
          type: string
          title: File Id
          description: File ID.
        type:
          type: string
          const: container_upload
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - file_id
      - type
      title: ContainerUploadBlockParam
      description: 'A content block for file upload to the container.


        Files uploaded via this block will be available in the container''s input
        directory.

        UNSUPPORTED on this implementation.'
    ContentBlockSourceParam:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/TextBlockParam'
              - $ref: '#/components/schemas/ImageBlockParam'
            type: array
          title: Content
          description: Content of the source.
        type:
          type: string
          const: content
          title: Type
          description: Type discriminator.
      type: object
      required:
      - content
      - type
      title: ContentBlockSourceParam
      description: Content block source for document content block.
    ContextManagement:
      properties:
        type:
          type: string
          const: compaction
          title: Type
          description: The context management entry type.
        compact_threshold:
          anyOf:
          - type: integer
            minimum: 1000.0
          - type: 'null'
          title: Compact Threshold
          description: Input tokens above which the conversation is compacted. An
            entry without it compacts nothing on this implementation.
      type: object
      required:
      - type
      title: ContextManagement
      description: A context management entry for the request.
    ContextManagementConfigParam:
      properties:
        edits:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/ClearToolUses20250919EditParam'
              - $ref: '#/components/schemas/ClearThinking20251015EditParam'
              discriminator:
                propertyName: type
                mapping:
                  clear_thinking_20251015: '#/components/schemas/ClearThinking20251015EditParam'
                  clear_tool_uses_20250919: '#/components/schemas/ClearToolUses20250919EditParam'
            type: array
          - type: 'null'
          title: Edits
          description: Edits to apply, in order. `clear_thinking_20251015` must be
            first and requires thinking enabled or adaptive.
      type: object
      title: ContextManagementConfigParam
      description: Context editing applied before the prompt reaches the model.
    ContextManagementResponse:
      properties:
        applied_edits:
          items:
            oneOf:
            - $ref: '#/components/schemas/ClearToolUses20250919EditResponse'
            - $ref: '#/components/schemas/ClearThinking20251015EditResponse'
            discriminator:
              propertyName: type
              mapping:
                clear_thinking_20251015: '#/components/schemas/ClearThinking20251015EditResponse'
                clear_tool_uses_20250919: '#/components/schemas/ClearToolUses20250919EditResponse'
          type: array
          title: Applied Edits
          description: Edits that were applied.
      type: object
      required:
      - applied_edits
      title: ContextManagementResponse
      description: Context edits applied to the prompt of this request.
    ConversationCreateParams:
      properties:
        items:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Input'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Input'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Items
          description: Initial items of the conversation, at most 20.
        metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Metadata
          description: Up to 16 key-value pairs attached to the conversation, with
            keys of at most 64 characters and string values of at most 512 characters.
      type: object
      title: ConversationCreateParams
      description: Request body for POST /v1/conversations.
    ConversationDeleted:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the deleted conversation.
        object:
          type: string
          const: conversation.deleted
          title: Object
          description: The object type. Always `conversation.deleted`.
          default: conversation.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Always `true`.
          default: true
      additionalProperties: false
      type: object
      required:
      - id
      title: ConversationDeleted
      description: Confirmation that a conversation was deleted.
    ConversationItemList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        object:
          type: string
          const: list
          title: Object
          description: The object type. Always `list`.
          default: list
        data:
          items:
            anyOf:
            - $ref: '#/components/schemas/ResponseInputMessageItem'
            - $ref: '#/components/schemas/ResponseOutputMessage'
            - $ref: '#/components/schemas/ResponseOutputMessageInput-Output'
            - $ref: '#/components/schemas/ResponseFileSearchToolCall'
            - $ref: '#/components/schemas/FileSearchCallInput'
            - $ref: '#/components/schemas/ResponseComputerToolCall'
            - $ref: '#/components/schemas/ComputerCallInput'
            - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseFunctionWebSearch'
            - $ref: '#/components/schemas/WebSearchCallInput'
            - $ref: '#/components/schemas/ResponseFunctionToolCallItem'
            - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseToolSearchCall'
            - $ref: '#/components/schemas/ToolSearchCallInput'
            - $ref: '#/components/schemas/ResponseToolSearchOutputItem'
            - $ref: '#/components/schemas/ToolSearchOutputInput'
            - $ref: '#/components/schemas/AdditionalTools'
            - $ref: '#/components/schemas/ResponseConfigurationUpdateItem'
            - $ref: '#/components/schemas/ResponseReasoningItem'
            - $ref: '#/components/schemas/ResponseReasoningItemInput'
            - $ref: '#/components/schemas/ResponseCompactionItem'
            - $ref: '#/components/schemas/ImageGenerationCall'
            - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall'
            - $ref: '#/components/schemas/CodeInterpreterCallInput'
            - $ref: '#/components/schemas/LocalShellCall'
            - $ref: '#/components/schemas/LocalShellCallOutput'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCall'
            - $ref: '#/components/schemas/ShellCall'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCall'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput'
            - $ref: '#/components/schemas/McpListTools'
            - $ref: '#/components/schemas/McpApprovalRequest'
            - $ref: '#/components/schemas/McpApprovalResponseOutput'
            - $ref: '#/components/schemas/McpCall'
            - $ref: '#/components/schemas/ResponseCustomToolCallItem'
            - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem'
            - $ref: '#/components/schemas/Program'
            - $ref: '#/components/schemas/ProgramOutput'
          type: array
          title: Data
          description: The items in this page.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      title: ConversationItemList
      description: A paginated list of conversation items.
    ConversationItemsCreateParams:
      properties:
        items:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Input'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Input'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Items
          description: Items to append to the conversation, at least one and at most
            20.
      type: object
      title: ConversationItemsCreateParams
      description: Request body for POST /v1/conversations/{conversation_id}/items.
    ConversationObject:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the conversation.
      type: object
      required:
      - id
      title: ConversationObject
      description: A conversation reference passed as an object with an ID.
    ConversationUpdateParams:
      properties:
        metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Metadata
          description: Key-value pairs merged into the conversation's metadata; a
            key set to null is removed. Required.
      type: object
      title: ConversationUpdateParams
      description: Request body for POST /v1/conversations/{conversation_id}.
    CopyRequest:
      properties:
        source:
          type: string
          title: Source
          description: Existing model name to copy from.
        destination:
          type: string
          title: Destination
          description: New model name to create.
      type: object
      required:
      - source
      - destination
      title: CopyRequest
      description: Copy a model request.
    CostsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        object:
          type: string
          const: organization.costs.result
          title: Object
          default: organization.costs.result
        amount:
          anyOf:
          - $ref: '#/components/schemas/UsageAmount'
          - type: 'null'
          description: The billed amount.
        line_item:
          anyOf:
          - type: string
          - type: 'null'
          title: Line Item
          description: Set when grouping by line_item.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        quantity:
          anyOf:
          - type: number
          - type: 'null'
          title: Quantity
          description: Quantity the amount was billed for.
      additionalProperties: false
      type: object
      title: CostsResult
      description: Aggregated cost of one time bucket.
    CountTokensContextManagementResponse:
      properties:
        original_input_tokens:
          type: integer
          title: Original Input Tokens
          description: Input tokens before context editing was applied.
      type: object
      required:
      - original_input_tokens
      title: CountTokensContextManagementResponse
      description: Context editing details of a token count.
    CreateEmbeddingResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
        data:
          items:
            $ref: '#/components/schemas/Embedding'
          type: array
          title: Data
          description: The list of embeddings generated by the model.
        model:
          type: string
          title: Model
          description: The name of the model used to generate the embedding.
        usage:
          $ref: '#/components/schemas/stdapi__types__openai_embeddings__Usage'
          description: The usage information for the request.
      additionalProperties: false
      type: object
      required:
      - object
      - data
      - model
      - usage
      title: CreateEmbeddingResponse
      description: Embedding response model.
    CreateRequest:
      properties:
        model:
          type: string
          title: Model
          description: Name for the model to create.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      title: CreateRequest
      description: Create a model request.
    CreateUploadBody:
      properties:
        bytes:
          type: integer
          maximum: 53687091200000.0
          exclusiveMinimum: 0.0
          title: Bytes
          description: The number of bytes in the file you are uploading, at most
            48.8 TiB (10,000 parts of 5 GiB, the largest object the storage backend
            assembles).
        filename:
          type: string
          title: Filename
          description: The name of the file to upload.
        mime_type:
          type: string
          title: Mime Type
          description: The MIME type of the file.
        purpose:
          type: string
          enum:
          - assistants
          - batch
          - fine-tune
          - vision
          - user_data
          - evals
          title: Purpose
          description: The intended purpose of the uploaded file.
        expires_after:
          anyOf:
          - $ref: '#/components/schemas/UploadExpiresAfter'
          - type: 'null'
          description: Expiration policy for the resulting file. By default the file
            persists until manually deleted.
      type: object
      required:
      - bytes
      - filename
      - mime_type
      - purpose
      title: CreateUploadBody
      description: Request body for ``POST /v1/uploads``.
    Custom:
      properties:
        name:
          type: string
          title: Name
          description: Name of the custom tool. UNSUPPORTED on this implementation.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the custom tool. UNSUPPORTED on this implementation.
        format:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CustomFormatText'
            - $ref: '#/components/schemas/CustomFormatGrammar'
            discriminator:
              propertyName: type
              mapping:
                grammar: '#/components/schemas/CustomFormatGrammar'
                text: '#/components/schemas/CustomFormatText'
          - type: 'null'
          title: Format
          description: 'Input format for the custom tool. Default: unconstrained text.
            UNSUPPORTED on this implementation.'
          default:
            type: text
      type: object
      required:
      - name
      title: Custom
      description: 'Properties of the custom tool used for custom tool calling.


        UNSUPPORTED on this implementation.'
    CustomFormatGrammar:
      properties:
        type:
          type: string
          const: grammar
          title: Type
          description: Format type. Always `grammar`. UNSUPPORTED on this implementation.
        grammar:
          $ref: '#/components/schemas/CustomFormatGrammarGrammar'
          description: Grammar definition. UNSUPPORTED on this implementation.
      type: object
      required:
      - type
      - grammar
      title: CustomFormatGrammar
      description: 'Grammar format. Always `grammar`.


        UNSUPPORTED on this implementation.'
    CustomFormatGrammarGrammar:
      properties:
        definition:
          type: string
          title: Definition
          description: Grammar definition. UNSUPPORTED on this implementation.
        syntax:
          type: string
          enum:
          - lark
          - regex
          title: Syntax
          description: 'Grammar syntax: `lark` or `regex`. UNSUPPORTED on this implementation.'
      type: object
      required:
      - definition
      - syntax
      title: CustomFormatGrammarGrammar
      description: 'The grammar definition and syntax for a grammar-based custom tool
        input.


        UNSUPPORTED on this implementation.'
    CustomFormatText:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Format type. Always `text`. UNSUPPORTED on this implementation.
      type: object
      required:
      - type
      title: CustomFormatText
      description: 'Unconstrained text format. Always `text`.


        UNSUPPORTED on this implementation.'
    CustomToolCallInput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: An identifier used to map this custom tool call to a tool call
            output.
        input:
          type: string
          title: Input
          description: The input for the custom tool call generated by the model.
        name:
          type: string
          title: Name
          description: The name of the custom tool being called.
        type:
          type: string
          const: custom_tool_call
          title: Type
          description: The type of the custom tool call. Always `custom_tool_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the custom tool call.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: The namespace of the custom tool being called.
      type: object
      required:
      - call_id
      - input
      - name
      - type
      title: CustomToolCallInput
      description: A call to a custom tool created by the model (as input item).
    CustomToolCallOutput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The call ID, used to map this custom tool call output to a
            custom tool call.
        output:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Output
          description: The output from the custom tool call. Can be a string or a
            list of output content.
        type:
          type: string
          const: custom_tool_call_output
          title: Type
          description: The type of the custom tool call output. Always `custom_tool_call_output`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the custom tool call output.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
      type: object
      required:
      - call_id
      - output
      - type
      title: CustomToolCallOutput
      description: The output of a custom tool call from your code, being sent back
        to the model.
    CustomToolChoice:
      properties:
        name:
          type: string
          title: Name
          description: 'The name of the custom tool to call.

            UNSUPPORTED on this implementation.'
      type: object
      required:
      - name
      title: CustomToolChoice
      description: 'The custom tool to call by name.


        UNSUPPORTED on this implementation.'
    CustomToolInputFormatGrammar:
      properties:
        definition:
          type: string
          title: Definition
          description: The grammar definition.
        syntax:
          type: string
          enum:
          - lark
          - regex
          title: Syntax
          description: 'Grammar syntax type: `lark` or `regex`.'
        type:
          type: string
          const: grammar
          title: Type
          description: Grammar format identifier.
      type: object
      required:
      - definition
      - syntax
      - type
      title: CustomToolInputFormatGrammar
      description: A grammar-constrained input format.
    CustomToolInputFormatText:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Text format identifier.
      type: object
      required:
      - type
      title: CustomToolInputFormatText
      description: Unconstrained free-form text input format.
    DeleteRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name to delete.
      type: object
      required:
      - model
      title: DeleteRequest
      description: Delete a model request.
    DeletedFile:
      properties:
        id:
          type: string
          title: Id
          description: ID of the deleted file.
        type:
          type: string
          const: file_deleted
          title: Type
          description: Deleted object type ("file_deleted").
          default: file_deleted
      additionalProperties: false
      type: object
      required:
      - id
      title: DeletedFile
      description: Response returned when a file is deleted via the Files API.
    DeletedMessageBatch:
      properties:
        id:
          type: string
          title: Id
          description: ID of the deleted Message Batch.
        type:
          type: string
          const: message_batch_deleted
          title: Type
          description: Deleted object type. Always `message_batch_deleted`.
          default: message_batch_deleted
      additionalProperties: false
      type: object
      required:
      - id
      title: DeletedMessageBatch
      description: Message Batch deletion confirmation.
    Dimension:
      type: string
      enum:
      - input_tokens
      - output_tokens
      - cache_read_tokens
      - cache_write_tokens
      - output_images
      - input_seconds
      - input_characters
      - comprehend_units
      - grounding_requests
      - search_units
      - input_images
      - output_seconds
      - text_units
      title: Dimension
      description: Billed dimension types tracked for cost computation.
    DirectCaller:
      properties:
        type:
          type: string
          const: direct
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - type
      title: DirectCaller
      description: Caller.
    DocumentBlock:
      properties:
        citations:
          anyOf:
          - $ref: '#/components/schemas/CitationsConfig'
          - type: 'null'
          description: Citation configuration for the document
        source:
          oneOf:
          - $ref: '#/components/schemas/Base64PDFSource'
          - $ref: '#/components/schemas/PlainTextSource'
          title: Source
          description: The document source.
          discriminator:
            propertyName: type
            mapping:
              base64: '#/components/schemas/Base64PDFSource'
              text: '#/components/schemas/PlainTextSource'
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Document title
        type:
          type: string
          const: document
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - source
      - type
      title: DocumentBlock
      description: Document block.
    DocumentBlockParam:
      properties:
        type:
          type: string
          const: document
          title: Type
          description: Content block type. Always `document`.
        source:
          oneOf:
          - $ref: '#/components/schemas/Base64PDFSource'
          - $ref: '#/components/schemas/PlainTextSourceParam'
          - $ref: '#/components/schemas/ContentBlockSourceParam'
          - $ref: '#/components/schemas/URLPDFSource'
          - $ref: '#/components/schemas/FileSource'
          title: Source
          description: Document source data.
          discriminator:
            propertyName: type
            mapping:
              base64: '#/components/schemas/Base64PDFSource'
              content: '#/components/schemas/ContentBlockSourceParam'
              file: '#/components/schemas/FileSource'
              text: '#/components/schemas/PlainTextSourceParam'
              url: '#/components/schemas/URLPDFSource'
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        citations:
          anyOf:
          - $ref: '#/components/schemas/CitationsConfigParam'
          - type: 'null'
          description: Citation configuration for the document
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
          description: Additional context for the document.
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
          description: Document title
      type: object
      required:
      - type
      - source
      title: DocumentBlockParam
      description: Document content block parameter.
    EasyInputMessage-Input:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Content
          description: Text, image, or audio input for the model.
        role:
          type: string
          enum:
          - user
          - assistant
          - system
          - developer
          title: Role
          description: 'Message role: `user`, `assistant`, `system`, or `developer`.'
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Message item ID.
        phase:
          anyOf:
          - type: string
            enum:
            - commentary
            - final_answer
          - type: 'null'
          title: Phase
          description: Labels an assistant message as commentary or final answer.
            Accepted on an assistant message and ignored; rejected under any other
            role.
        type:
          anyOf:
          - type: string
            const: message
          - type: 'null'
          title: Type
          description: Message input type.
      type: object
      required:
      - content
      - role
      title: EasyInputMessage
      description: 'A message input to the model with a role indicating instruction
        following hierarchy.


        ``id`` is absent from the SDK''s request type but present on every message
        item

        the API hands back, so a client replaying a listed item -- Codex does, from
        the

        first turn on -- sends it. It is read-only here; only the role and content
        act.'
    EasyInputMessage-Output:
      properties:
        content:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Content
          description: Text, image, or audio input for the model.
        role:
          type: string
          enum:
          - user
          - assistant
          - system
          - developer
          title: Role
          description: 'Message role: `user`, `assistant`, `system`, or `developer`.'
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Message item ID.
        type:
          anyOf:
          - type: string
            const: message
          - type: 'null'
          title: Type
          description: Message input type.
      type: object
      required:
      - content
      - role
      title: EasyInputMessage
      description: 'A message input to the model with a role indicating instruction
        following hierarchy.


        ``id`` is absent from the SDK''s request type but present on every message
        item

        the API hands back, so a client replaying a listed item -- Codex does, from
        the

        first turn on -- sends it. It is read-only here; only the role and content
        act.'
    EmbedInput:
      properties:
        content:
          items:
            oneOf:
            - $ref: '#/components/schemas/EmbedInputContentText'
            - $ref: '#/components/schemas/EmbedInputContentImageUrl'
            discriminator:
              propertyName: type
              mapping:
                image_url: '#/components/schemas/EmbedInputContentImageUrl'
                text: '#/components/schemas/EmbedInputContentText'
          type: array
          minItems: 1
          title: Content
          description: Content parts embedded together into a single vector. Two or
            more parts require a Cohere Embed v4 model; a single part is accepted
            by every embedding model.
      type: object
      required:
      - content
      title: EmbedInput
      description: One input to embed, made of one or more content parts.
    EmbedInputContentImageUrl:
      properties:
        type:
          type: string
          const: image_url
          title: Type
          description: Content part type.
        image_url:
          $ref: '#/components/schemas/EmbedInputImageUrl'
          description: Image embedded as part of this input.
      type: object
      required:
      - type
      - image_url
      title: EmbedInputContentImageUrl
      description: Image part of an input.
    EmbedInputContentText:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content part type.
        text:
          type: string
          title: Text
          description: Text embedded as part of this input.
      type: object
      required:
      - type
      - text
      title: EmbedInputContentText
      description: Text part of an input.
    EmbedInputImageUrl:
      properties:
        url:
          type: string
          minLength: 1
          pattern: ^(?:https?://|s3://|data:|file-id:)
          title: Url
          description: Image data URI. URLs and S3 URIs are also accepted (beyond
            the original Cohere API).
      type: object
      required:
      - url
      title: EmbedInputImageUrl
      description: Image of an input content part.
    EmbedV1FloatsResponse:
      properties:
        response_type:
          type: string
          const: embeddings_floats
          title: Response Type
          description: Response envelope type, always `embeddings_floats`.
          default: embeddings_floats
        id:
          type: string
          title: Id
          description: Unique identifier of the request.
        embeddings:
          items:
            items:
              type: number
            type: array
          type: array
          title: Embeddings
          description: Float embedding vectors, one per input.
        texts:
          items:
            type: string
          type: array
          title: Texts
          description: The text entries for which embeddings were returned.
        images:
          anyOf:
          - items:
              $ref: '#/components/schemas/ImageDescription'
            type: array
          - type: 'null'
          title: Images
          description: Metadata of the image entries for which embeddings were returned.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      additionalProperties: false
      type: object
      required:
      - id
      - embeddings
      - meta
      title: EmbedV1FloatsResponse
      description: Embed response model (legacy v1 `embeddings_floats` format).
    EmbedV1Request:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        texts:
          anyOf:
          - items:
              type: string
            type: array
            minItems: 1
          - type: 'null'
          title: Texts
          description: An array of strings for the model to embed.
        images:
          anyOf:
          - items:
              type: string
              minLength: 1
              pattern: ^(?:https?://|s3://|data:|file-id:)
            type: array
            minItems: 1
          - type: 'null'
          title: Images
          description: An array of image data URIs for the model to embed. URLs and
            S3 URIs are also accepted (beyond the original Cohere API).
        embedding_types:
          anyOf:
          - items:
              type: string
              enum:
              - float
              - int8
              - uint8
              - binary
              - ubinary
              - base64
            type: array
          - type: 'null'
          title: Embedding Types
          description: Embedding types to return. `int8`/`uint8`/`binary`/`ubinary`
            are supported by Cohere Embed models, `binary` also by Titan Embed v2;
            other combinations return 400. `base64` is always accepted and computed
            client-side (little-endian float32 bytes) from the `float` embedding.
        truncate:
          anyOf:
          - type: string
            enum:
            - NONE
            - START
            - END
          - type: 'null'
          title: Truncate
          description: How to handle inputs longer than the maximum token length.
            Supported by Cohere models only.
        input_type:
          anyOf:
          - type: string
            enum:
            - search_document
            - search_query
            - classification
            - clustering
            - image
          - type: 'null'
          title: Input Type
          description: 'Specifies the type of input passed to the model. Optional
            in the v1 API: forwarded to Cohere models when provided (defaults to `search_document`
            otherwise); other embedding models have no equivalent and the value is
            ignored.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      title: EmbedV1Request
      description: Request body for creating embeddings (Cohere v1 Embed API).
    Embedding:
      properties:
        object:
          type: string
          const: embedding
          title: Object
          description: The object type, which is always `embedding`.
        index:
          type: integer
          title: Index
          description: The index of the embedding in the list of embeddings.
        embedding:
          anyOf:
          - items:
              type: number
            type: array
          - type: string
          title: Embedding
          description: The embedding vector, which is a list of floats or a base64
            string.
      additionalProperties: false
      type: object
      required:
      - object
      - index
      - embedding
      title: Embedding
      description: 'Custom embedding model that supports both float lists and base64
        strings.


        This extends the OpenAI embedding format to handle base64 encoding properly.'
    EmbeddingCreateParams:
      properties:
        input:
          anyOf:
          - type: string
            minLength: 1
            pattern: ^(?:https?://|s3://|data:|file-id:)
          - type: string
          - items:
              anyOf:
              - type: string
                minLength: 1
                pattern: ^(?:https?://|s3://|data:|file-id:)
              - type: string
              - type: integer
              - items:
                  type: integer
                type: array
            type: array
            minItems: 1
          title: Input
          description: Input text to embed, as a single string or array of strings.
            For multimodal models, non-text inputs can be a URL, S3 URI, base64 data
            URI, or Files API reference. Token arrays are UNSUPPORTED on this implementation.
            An empty array is rejected.
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        dimensions:
          anyOf:
          - type: integer
            maximum: 8192.0
            minimum: 1.0
          - type: 'null'
          title: Dimensions
          description: The number of dimensions the resulting output embeddings should
            have. Supported by some models only.
        encoding_format:
          anyOf:
          - type: string
            enum:
            - float
            - base64
          - type: 'null'
          title: Encoding Format
          description: 'The format to return the embeddings in: `float` or `base64`.'
          default: float
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: A unique identifier representing your end-user, which can help
            detect abuse.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - input
      - model
      title: EmbeddingCreateParams
      description: 'Request body for creating embeddings.


        Validates unsupported values and combinations to match OpenAI behavior.'
    EmbeddingsByType:
      properties:
        float:
          anyOf:
          - items:
              items:
                type: number
              type: array
            type: array
          - type: 'null'
          title: Float
          description: Float embedding vectors, one per input.
        int8:
          anyOf:
          - items:
              items:
                type: integer
              type: array
            type: array
          - type: 'null'
          title: Int8
          description: Int8-quantized embedding vectors, one per input. Cohere models
            only.
        uint8:
          anyOf:
          - items:
              items:
                type: integer
              type: array
            type: array
          - type: 'null'
          title: Uint8
          description: Uint8-quantized embedding vectors, one per input. Cohere models
            only.
        binary:
          anyOf:
          - items:
              items:
                type: integer
              type: array
            type: array
          - type: 'null'
          title: Binary
          description: Bit-packed signed-binary embedding vectors, one per input.
            Cohere and Titan Embed v2 models.
        ubinary:
          anyOf:
          - items:
              items:
                type: integer
              type: array
            type: array
          - type: 'null'
          title: Ubinary
          description: Bit-packed unsigned-binary embedding vectors, one per input.
            Cohere models only.
        base64:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Base64
          description: Base64-encoded float32 embedding vectors (little-endian byte
            order), one per input, computed client-side from the `float` embedding.
      additionalProperties: false
      type: object
      title: EmbeddingsByType
      description: 'Embeddings keyed by embedding type.


        Only the requested embedding types are populated, matching the Cohere API.'
    EmbeddingsRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name.
        prompt:
          type: string
          title: Prompt
          description: Text to embed.
          default: ''
        keep_alive:
          anyOf:
          - type: string
          - type: number
          - type: 'null'
          title: Keep Alive
          description: 'UNSUPPORTED, accepted and ignored: models are never resident.'
        options:
          anyOf:
          - $ref: '#/components/schemas/ModelOptions'
          - type: 'null'
          description: Runtime options; ignored for embeddings.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      title: EmbeddingsRequest
      description: Create a single embedding request (deprecated, use `/api/embed`).
    EmbeddingsResponse:
      properties:
        embedding:
          items:
            type: number
          type: array
          title: Embedding
          description: Embedding vector for the prompt.
      additionalProperties: false
      type: object
      required:
      - embedding
      title: EmbeddingsResponse
      description: Single embedding response (deprecated, use `/api/embed`).
    EmbeddingsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.embeddings.result
          title: Object
          default: organization.usage.embeddings.result
        input_tokens:
          type: integer
          title: Input Tokens
          description: Input tokens.
          default: 0
      additionalProperties: false
      type: object
      title: EmbeddingsResult
      description: Aggregated embeddings usage of one time bucket.
    EncryptedCodeExecutionResultBlock:
      properties:
        content:
          items:
            $ref: '#/components/schemas/CodeExecutionOutputBlock'
          type: array
          title: Content
          description: Block content.
        encrypted_stdout:
          type: string
          title: Encrypted Stdout
          description: Encrypted standard output.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        type:
          type: string
          const: encrypted_code_execution_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - encrypted_stdout
      - return_code
      - stderr
      - type
      title: EncryptedCodeExecutionResultBlock
      description: Code execution result with encrypted stdout for PFC + web_search
        results.
    EncryptedCodeExecutionResultBlockParam:
      properties:
        content:
          items:
            $ref: '#/components/schemas/CodeExecutionOutputBlockParam'
          type: array
          title: Content
          description: Block content.
        encrypted_stdout:
          type: string
          title: Encrypted Stdout
          description: Encrypted standard output.
        return_code:
          type: integer
          title: Return Code
          description: Return code.
        stderr:
          type: string
          title: Stderr
          description: Stderr.
        type:
          type: string
          const: encrypted_code_execution_result
          title: Type
          description: Type discriminator.
      type: object
      required:
      - content
      - encrypted_stdout
      - return_code
      - stderr
      - type
      title: EncryptedCodeExecutionResultBlockParam
      description: Code execution result with encrypted stdout for PFC + web_search
        results.
    ExpiresAfter:
      properties:
        anchor:
          type: string
          const: last_active_at
          title: Anchor
          description: Timestamp the expiration is counted from.
          default: last_active_at
        days:
          type: integer
          minimum: 1.0
          title: Days
          description: Number of days after the anchor before the store expires.
      additionalProperties: false
      type: object
      required:
      - days
      title: ExpiresAfter
      description: Expiration policy of a vector store.
    File:
      properties:
        type:
          type: string
          const: file
          title: Type
          description: Content part type. Always `file`.
        file:
          $ref: '#/components/schemas/FileFile'
          description: Content descriptor containing base64 bytes.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      - file
      title: File
      description: File message content part.
    FileBatchCreateParams:
      properties:
        file_ids:
          anyOf:
          - items:
              type: string
              pattern: ^file[-_][a-z0-9]{32}$
            type: array
            maxItems: 2000
          - type: 'null'
          title: File Ids
          description: IDs of uploaded files to index, at most 2000. Mutually exclusive
            with `files`.
        files:
          anyOf:
          - items:
              $ref: '#/components/schemas/FileBatchFile'
            type: array
            maxItems: 2000
          - type: 'null'
          title: Files
          description: Files to index with per-file `attributes` or `chunking_strategy`,
            at most 2000. Mutually exclusive with `file_ids`.
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: Up to 16 key-value pairs stored with the file and usable in
            search `filters`. Keys are at most 64 characters; values are strings of
            at most 512 characters, numbers, or booleans. Applied to every file in
            `file_ids`.
        chunking_strategy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/AutoChunkingStrategyParam'
            - $ref: '#/components/schemas/StaticChunkingStrategyParam'
            discriminator:
              propertyName: type
              mapping:
                auto: '#/components/schemas/AutoChunkingStrategyParam'
                static: '#/components/schemas/StaticChunkingStrategyParam'
          - type: 'null'
          title: Chunking Strategy
          description: How every file in `file_ids` is split before indexing.
      type: object
      title: FileBatchCreateParams
      description: Request body of `POST /v1/vector_stores/{vector_store_id}/file_batches`.
    FileBatchFile:
      properties:
        file_id:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          title: File Id
          description: The ID of an uploaded file the vector store should index.
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: Up to 16 key-value pairs stored with the file and usable in
            search `filters`. Keys are at most 64 characters; values are strings of
            at most 512 characters, numbers, or booleans.
        chunking_strategy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/AutoChunkingStrategyParam'
            - $ref: '#/components/schemas/StaticChunkingStrategyParam'
            discriminator:
              propertyName: type
              mapping:
                auto: '#/components/schemas/AutoChunkingStrategyParam'
                static: '#/components/schemas/StaticChunkingStrategyParam'
          - type: 'null'
          title: Chunking Strategy
          description: How this file is split before indexing.
      type: object
      required:
      - file_id
      title: FileBatchFile
      description: One entry of a file batch, with its own attributes and chunking.
    FileContent:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Always `text`.
          default: text
        text:
          type: string
          title: Text
          description: The chunk text.
      additionalProperties: false
      type: object
      required:
      - text
      title: FileContent
      description: One indexed chunk of a file.
    FileContentPage:
      properties:
        object:
          type: string
          const: vector_store.file_content.page
          title: Object
          description: The object type.
          default: vector_store.file_content.page
        data:
          items:
            $ref: '#/components/schemas/FileContent'
          type: array
          title: Data
          description: The chunks, in document order.
        has_more:
          type: boolean
          title: Has More
          description: Always `false`.
          default: false
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: Always `null`.
      additionalProperties: false
      type: object
      required:
      - data
      title: FileContentPage
      description: One page of a file's indexed content.
    FileCounts:
      properties:
        in_progress:
          type: integer
          title: In Progress
          description: Files still being processed.
        completed:
          type: integer
          title: Completed
          description: Files successfully processed.
        failed:
          type: integer
          title: Failed
          description: Files that failed to process.
        cancelled:
          type: integer
          title: Cancelled
          description: Files whose processing was cancelled.
        total:
          type: integer
          title: Total
          description: Total number of files.
      additionalProperties: false
      type: object
      required:
      - in_progress
      - completed
      - failed
      - cancelled
      - total
      title: FileCounts
      description: Per-status counts of the files attached to a vector store.
    FileDeleted:
      properties:
        id:
          type: string
          title: Id
          description: The file identifier.
        object:
          type: string
          const: file
          title: Object
          description: The object type, which is always `file`.
          default: file
        deleted:
          type: boolean
          title: Deleted
          description: Whether the file was deleted.
      additionalProperties: false
      type: object
      required:
      - id
      - deleted
      title: FileDeleted
      description: Response returned when a file is deleted.
    FileFile:
      properties:
        file_id:
          anyOf:
          - type: string
            pattern: ^file[-_]
          - type: 'null'
          title: File Id
          description: ID of an uploaded file to use as input.
        file_data:
          anyOf:
          - type: string
            minLength: 1
          - type: 'null'
          title: File Data
          description: Base64-encoded file data, data URI, S3 URI, or URL.
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: Name of the file when passing as a string.
      type: object
      title: FileFile
      description: File content descriptor.
    FileListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/FileMetadata'
          type: array
          title: Data
          description: List of file metadata objects.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more results available.
          default: false
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first file in this page of results.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last file in this page of results.
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: Opaque cursor to the page following this one, or null when
            this is the last page. Send it back as the `page` query parameter.
      additionalProperties: false
      type: object
      required:
      - data
      title: FileListResponse
      description: Paginated list of files returned by GET /v1/files.
    FileMetadata:
      properties:
        id:
          type: string
          title: Id
          description: Unique object identifier. The format and length of IDs may
            change over time.
        type:
          type: string
          const: file
          title: Type
          description: Object type ("file").
          default: file
        filename:
          type: string
          title: Filename
          description: Original filename of the uploaded file.
        mime_type:
          type: string
          title: Mime Type
          description: MIME type of the file.
        size_bytes:
          type: integer
          title: Size Bytes
          description: Size of the file in bytes.
        created_at:
          type: string
          title: Created At
          description: RFC 3339 datetime string representing when the file was created.
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: RFC 3339 datetime string representing when the file will expire,
            or `null` if the file does not have an expiry.
        downloadable:
          type: boolean
          title: Downloadable
          description: Whether the file can be downloaded.
          default: true
      additionalProperties: false
      type: object
      required:
      - id
      - filename
      - mime_type
      - size_bytes
      - created_at
      title: FileMetadata
      description: The `FileMetadata` object represents a file that has been uploaded
        to the API.
    FileObject:
      properties:
        id:
          type: string
          title: Id
          description: The file identifier, which can be referenced in the API endpoints.
        object:
          type: string
          const: file
          title: Object
          description: The object type, which is always `file`.
          default: file
        bytes:
          type: integer
          title: Bytes
          description: The file size in bytes.
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (in seconds) when the file was created.
        filename:
          type: string
          title: Filename
          description: The name of the file.
        purpose:
          type: string
          title: Purpose
          description: The intended purpose of the file.
        status:
          type: string
          enum:
          - uploaded
          - processed
          - error
          title: Status
          description: Deprecated. The current status of the file.
          default: processed
        expires_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires At
          description: The Unix timestamp (in seconds) for when the file will expire.
        status_details:
          anyOf:
          - type: string
          - type: 'null'
          title: Status Details
          description: Deprecated. Details on why a fine-tuning training file failed
            validation.
      additionalProperties: false
      type: object
      required:
      - id
      - bytes
      - created_at
      - filename
      - purpose
      title: FileObject
      description: The `File` object represents a document that has been uploaded
        to the API.
    FileSearchCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the file search tool call.
        queries:
          items:
            type: string
          type: array
          title: Queries
          description: The queries used to search for files.
        status:
          type: string
          enum:
          - in_progress
          - searching
          - completed
          - incomplete
          - failed
          title: Status
          description: The status of the file search tool call.
        type:
          type: string
          const: file_search_call
          title: Type
          description: The type of the file search tool call. Always `file_search_call`.
        results:
          anyOf:
          - items:
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
            type: array
          - type: 'null'
          title: Results
          description: The results of the file search tool call.
      type: object
      required:
      - id
      - queries
      - status
      - type
      title: FileSearchCallInput
      description: The results of a file search tool call (as input item).
    FileSearchRankingOptions:
      properties:
        hybrid_search:
          anyOf:
          - $ref: '#/components/schemas/FileSearchRankingOptionsHybridSearch'
          - type: 'null'
          description: Weights for hybrid search reciprocal rank fusion.
        ranker:
          anyOf:
          - type: string
            enum:
            - auto
            - default-2024-11-15
          - type: 'null'
          title: Ranker
          description: File search ranker.
        score_threshold:
          anyOf:
          - type: number
          - type: 'null'
          title: Score Threshold
          description: Score threshold (0 to 1).
      type: object
      title: FileSearchRankingOptions
      description: Ranking options for file search.
    FileSearchRankingOptionsHybridSearch:
      properties:
        embedding_weight:
          type: number
          title: Embedding Weight
          description: Embedding weight for reciprocal rank fusion.
        text_weight:
          type: number
          title: Text Weight
          description: Text weight for reciprocal rank fusion.
      type: object
      required:
      - embedding_weight
      - text_weight
      title: FileSearchRankingOptionsHybridSearch
      description: Hybrid search weighting for reciprocal rank fusion.
    FileSearchResult:
      properties:
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: string
              - type: number
              - type: boolean
            type: object
          - type: 'null'
          title: Attributes
          description: Key-value pairs for the file.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: File ID.
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: Filename.
        score:
          anyOf:
          - type: number
          - type: 'null'
          title: Score
          description: Relevance score (0-1).
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
          description: Retrieved text from file.
      additionalProperties: false
      type: object
      title: FileSearchResult
      description: A file search result.
    FileSearchTool:
      properties:
        type:
          type: string
          const: file_search
          title: Type
          description: File search tool type.
        vector_store_ids:
          items:
            type: string
          type: array
          minItems: 1
          title: Vector Store Ids
          description: Vector store IDs to search; at least one.
        filters:
          anyOf:
          - $ref: '#/components/schemas/ComparisonFilter-Output'
          - $ref: '#/components/schemas/CompoundFilter-Output'
          - type: 'null'
          title: Filters
          description: Filter to apply.
        max_num_results:
          anyOf:
          - type: integer
            maximum: 50.0
            minimum: 1.0
          - type: 'null'
          title: Max Num Results
          description: Maximum results to return (1-50).
        ranking_options:
          anyOf:
          - $ref: '#/components/schemas/FileSearchRankingOptions'
          - type: 'null'
          description: Ranking options for search.
      type: object
      required:
      - type
      - vector_store_ids
      title: FileSearchTool
      description: A tool that searches for relevant content in the attached vector
        stores.
    FileSearchesResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        object:
          type: string
          const: organization.usage.file_searches.result
          title: Object
          default: organization.usage.file_searches.result
        num_requests:
          type: integer
          title: Num Requests
          description: Number of file search requests.
          default: 0
        vector_store_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Vector Store Id
          description: Set when grouping by vector_store_id.
      additionalProperties: false
      type: object
      title: FileSearchesResult
      description: Aggregated file search usage of one time bucket.
    FileSource:
      properties:
        type:
          type: string
          const: file
          title: Type
          description: Source type.
        file_id:
          type: string
          pattern: ^file[-_]
          title: File Id
          description: Files API file identifier.
      type: object
      required:
      - type
      - file_id
      title: FileSource
      description: File source for document or image content block (Files API).
    FunctionCall:
      properties:
        name:
          type: string
          title: Name
          description: The name of the function to call.
        arguments:
          type: string
          title: Arguments
          description: JSON arguments for the function call. May be invalid or hallucinated;
            validate before use.
      type: object
      required:
      - name
      - arguments
      title: FunctionCall
      description: Function tool call payload used within assistant tool calls.
    FunctionCallInput:
      properties:
        arguments:
          type: string
          title: Arguments
          description: A JSON string of the arguments passed to the function.
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the function tool call generated by the model.
        name:
          type: string
          title: Name
          description: The name of the function that was called.
        type:
          type: string
          const: function_call
          title: Type
          description: The type of the function tool call. Always `function_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the function tool call.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: The namespace of the function to run.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the item.
      type: object
      required:
      - arguments
      - call_id
      - name
      - type
      title: FunctionCallInput
      description: A function tool call echoed back as an input item from a previous
        response.
    FunctionCallOutput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the function tool call generated by the model.
        output:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Output
          description: Text, image, or file output of the function tool call.
        type:
          type: string
          const: function_call_output
          title: Type
          description: The type of the function tool call output. Always `function_call_output`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the function tool call output. Populated when
            this item is returned via API.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the item. One of `in_progress`, `completed`,
            or `incomplete`. Populated when items are returned via API.
      type: object
      required:
      - call_id
      - output
      - type
      title: FunctionCallOutput
      description: The output of a function tool call.
    FunctionDefinition:
      properties:
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Whether to enable strict schema adherence when generating the
            function call. If true, the model follows the exact schema in `parameters`;
            only a subset of JSON Schema is supported in that case.
        name:
          type: string
          title: Name
          description: The name of the function to be called.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: A description of what the function does.
        parameters:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Parameters
          description: The parameters the function accepts, described as a JSON Schema
            object. Omitting `parameters` defines a function with an empty parameter
            list.
      type: object
      required:
      - name
      title: FunctionDefinition
      description: Function tool definition following OpenAI shared schema.
    FunctionShellTool:
      properties:
        type:
          type: string
          const: shell
          title: Type
          description: Shell tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
        environment:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ContainerAuto'
            - $ref: '#/components/schemas/LocalEnvironment'
            - $ref: '#/components/schemas/ContainerReference'
            discriminator:
              propertyName: type
              mapping:
                container_auto: '#/components/schemas/ContainerAuto'
                container_reference: '#/components/schemas/ContainerReference'
                local: '#/components/schemas/LocalEnvironment'
          - type: 'null'
          title: Environment
          description: Environment for shell commands.
      type: object
      required:
      - type
      title: FunctionShellTool
      description: 'A tool that allows the model to execute shell commands.


        UNSUPPORTED on this implementation.'
    FunctionToolChoice:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: Kind of tool being named.
          default: function
        name:
          type: string
          title: Name
          description: Name of that function.
      type: object
      required:
      - name
      title: FunctionToolChoice
      description: The one function every answer must start by calling.
    FunctionToolChoiceParam:
      properties:
        name:
          type: string
          title: Name
          description: The name of the function to call.
      type: object
      required:
      - name
      title: FunctionToolChoiceParam
      description: The function to call by name.
    GenerateRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name.
        format:
          anyOf:
          - type: string
            enum:
            - ''
            - json
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Format
          description: 'Structured output: `json`, or a JSON schema the answer must
            match. An empty string asks for no structured output.'
        options:
          anyOf:
          - $ref: '#/components/schemas/ModelOptions'
          - type: 'null'
          description: Runtime generation options.
        stream:
          type: boolean
          title: Stream
          description: Return a stream of partial responses.
          default: true
        think:
          anyOf:
          - type: boolean
          - type: string
            enum:
            - low
            - medium
            - high
            - max
          - type: 'null'
          title: Think
          description: Return the model's thinking separately, optionally at a chosen
            level.
        keep_alive:
          anyOf:
          - type: string
          - type: number
          - type: 'null'
          title: Keep Alive
          description: 'UNSUPPORTED, accepted and ignored: models are never resident.'
        logprobs:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Logprobs
          description: 'UNSUPPORTED: log probabilities are not available.'
        top_logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top Logprobs
          description: 'UNSUPPORTED: log probabilities are not available.'
        prompt:
          type: string
          title: Prompt
          description: Text for the model to answer.
          default: ''
        system:
          anyOf:
          - type: string
          - type: 'null'
          title: System
          description: System prompt.
        images:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Images
          description: Images for multimodal models, base64-encoded or as a URL.
        suffix:
          anyOf:
          - type: string
          - type: 'null'
          title: Suffix
          description: 'UNSUPPORTED: fill-in-the-middle is not available.'
        template:
          anyOf:
          - type: string
          - type: 'null'
          title: Template
          description: 'UNSUPPORTED: prompt templates are not available.'
        context:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Context
          description: 'UNSUPPORTED: token contexts are not available.'
        raw:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Raw
          description: 'UNSUPPORTED: raw prompting is not available.'
      type: object
      required:
      - model
      title: GenerateRequest
      description: Create a single-prompt response request.
    GenerateResponse:
      properties:
        total_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Duration
          description: Total time spent answering, in nanoseconds.
        prompt_eval_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Count
          description: Number of input tokens.
        prompt_eval_cached_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Cached Count
          description: Number of input tokens read from the cache, included in `prompt_eval_count`.
        prompt_eval_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Duration
          description: Time to the first generated token, in nanoseconds.
        eval_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eval Count
          description: Number of generated tokens.
        eval_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eval Duration
          description: Time spent generating tokens after the first, in nanoseconds.
        model:
          type: string
          title: Model
          description: Model name, as the request spelled it.
        created_at:
          type: string
          title: Created At
          description: Creation timestamp, ISO 8601.
        response:
          type: string
          title: Response
          description: Generated text.
          default: ''
        thinking:
          anyOf:
          - type: string
          - type: 'null'
          title: Thinking
          description: Thinking text, when `think` is enabled.
        done:
          type: boolean
          title: Done
          description: Whether the response is complete.
        done_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Done Reason
          description: 'Why generation stopped: `stop` or `length`.'
      additionalProperties: false
      type: object
      required:
      - model
      - created_at
      - done
      title: GenerateResponse
      description: Generate response, and the terminal event of a generate stream.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Image:
      properties:
        b64_json:
          anyOf:
          - type: string
          - type: 'null'
          title: B64 Json
          description: Base64-encoded image data; present when response_format is
            `b64_json`.
        revised_prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Revised Prompt
          description: The revised prompt used to generate the image.
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
          description: URL of the generated image; present when response_format is
            `url`.
      additionalProperties: false
      type: object
      title: Image
      description: Generated image descriptor compatible with OpenAI.
    ImageBlockParam:
      properties:
        type:
          type: string
          const: image
          title: Type
          description: Content block type.
        source:
          oneOf:
          - $ref: '#/components/schemas/Base64ImageSource'
          - $ref: '#/components/schemas/URLImageSource'
          - $ref: '#/components/schemas/FileSource'
          title: Source
          description: Image source data.
          discriminator:
            propertyName: type
            mapping:
              base64: '#/components/schemas/Base64ImageSource'
              file: '#/components/schemas/FileSource'
              url: '#/components/schemas/URLImageSource'
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
      type: object
      required:
      - type
      - source
      title: ImageBlockParam
      description: Image content block parameter.
    ImageDescription:
      properties:
        width:
          type: integer
          title: Width
          description: Image width in pixels.
        height:
          type: integer
          title: Height
          description: Image height in pixels.
        format:
          type: string
          title: Format
          description: Image format (e.g. `png`, `jpeg`).
        bit_depth:
          type: integer
          title: Bit Depth
          description: Image bit depth.
      additionalProperties: false
      type: object
      required:
      - width
      - height
      - format
      - bit_depth
      title: ImageDescription
      description: Metadata of an embedded image, echoed back for image inputs.
    ImageGenerateParams:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: Model for image generation. Wildcard patterns are accepted
            and select the most recent matching model.
        response_format:
          type: string
          enum:
          - url
          - b64_json
          title: Response Format
          description: 'Format for returned images: `url` or `b64_json`. URLs expire
            after 60 minutes. Streaming always returns `b64_json`.'
          default: url
        n:
          type: integer
          maximum: 10.0
          minimum: 1.0
          title: N
          description: Number of images to generate.
          default: 1
        size:
          type: string
          pattern: ^(auto|\d+x\d+)$
          title: Size
          description: Size of the generated images, as `WIDTHxHEIGHT`, or `auto`
            to let the model pick. Supported values depend on the model; output size
            may differ.
          default: 1024x1024
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: User identifier for monitoring and abuse detection.
        prompt:
          type: string
          minLength: 1
          title: Prompt
          description: A text description of the desired image(s).
        background:
          anyOf:
          - type: string
            const: auto
          - type: string
            enum:
            - transparent
            - opaque
          title: Background
          description: 'Background transparency setting. If `transparent`, `output_format`
            must be `png` or `webp`.

            transparent is UNSUPPORTED on this implementation.'
          default: auto
        moderation:
          type: string
          enum:
          - low
          - auto
          title: Moderation
          description: 'Content-moderation level: `low` (less restrictive) or `auto`.

            low is UNSUPPORTED on this implementation.'
          default: auto
        output_compression:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Output Compression
          description: Compression level (0-100%) for generated images.
          default: 100
        output_format:
          anyOf:
          - type: string
            enum:
            - png
            - jpeg
            - webp
          - type: 'null'
          title: Output Format
          description: 'Output image format: `png`, `jpeg`, or `webp`.'
        partial_images:
          anyOf:
          - type: integer
            maximum: 3.0
            minimum: 0.0
          - type: 'null'
          title: Partial Images
          description: Number of partial images to generate during streaming (0-3;
            requires `stream=true`). 0 sends the final image as a single event. The
            final image may arrive before all partial images if generation finishes
            early, and partial images are only sent if the model supports them.
        quality:
          type: string
          maxLength: 255
          minLength: 1
          title: Quality
          description: Image quality. `auto` selects the best quality for the model;
            supported values depend on the model.
          default: auto
        style:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Style
          description: The style of the generated images; supported values depend
            on the model.
        stream:
          type: boolean
          title: Stream
          description: Generate the image in streaming mode.
          default: false
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - prompt
      title: ImageGenerateParams
      description: Request body for generating images.
    ImageGeneration:
      properties:
        type:
          type: string
          const: image_generation
          title: Type
          description: Image generation tool type.
        action:
          anyOf:
          - type: string
            enum:
            - generate
            - edit
            - auto
          - type: 'null'
          title: Action
          description: 'Generate new or edit existing image. Default: auto.'
        background:
          anyOf:
          - type: string
            enum:
            - transparent
            - opaque
            - auto
          - type: 'null'
          title: Background
          description: 'Background type: `transparent`, `opaque`, or `auto`. Default:
            auto.'
        input_fidelity:
          anyOf:
          - type: string
            enum:
            - high
            - low
          - type: 'null'
          title: Input Fidelity
          description: 'Match style/features of input images. Default: low.'
        input_image_mask:
          anyOf:
          - $ref: '#/components/schemas/ImageGenerationInputImageMask'
          - type: 'null'
          description: Mask for inpainting.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Image generation model. Wildcard patterns are accepted and
            select the most recent matching model.
        moderation:
          anyOf:
          - type: string
            enum:
            - auto
            - low
          - type: 'null'
          title: Moderation
          description: 'Moderation level. Default: auto.'
        output_compression:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Output Compression
          description: 'Output compression (0-100). Default: 100.'
        output_format:
          anyOf:
          - type: string
            enum:
            - png
            - webp
            - jpeg
          - type: 'null'
          title: Output Format
          description: 'Output format: `png`, `webp`, or `jpeg`. Default: png.'
        partial_images:
          anyOf:
          - type: integer
            maximum: 3.0
            minimum: 0.0
          - type: 'null'
          title: Partial Images
          description: 'Partial images for streaming (0-3). Default: 0.'
        quality:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
            - auto
          - type: 'null'
          title: Quality
          description: 'Image quality: `low`, `medium`, `high`, or `auto`. Default:
            auto.'
        size:
          anyOf:
          - type: string
            enum:
            - 1024x1024
            - 1024x1536
            - 1536x1024
            - auto
          - type: 'null'
          title: Size
          description: 'Image size: `1024x1024`, `1024x1536`, `1536x1024`, or `auto`.
            Default: auto.'
      type: object
      required:
      - type
      title: ImageGeneration
      description: A tool that generates images.
    ImageGenerationCall:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the image generation call.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - generating
          - failed
          title: Status
          description: The status of the image generation call.
        type:
          type: string
          const: image_generation_call
          title: Type
          description: The type of the image generation call. Always `image_generation_call`.
        result:
          anyOf:
          - type: string
          - type: 'null'
          title: Result
          description: The generated image encoded in base64.
      additionalProperties: false
      type: object
      required:
      - id
      - status
      - type
      title: ImageGenerationCall
      description: An image generation request made by the model.
    ImageGenerationCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the image generation call.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - generating
          - failed
          title: Status
          description: The status of the image generation call.
        type:
          type: string
          const: image_generation_call
          title: Type
          description: The type of the image generation call. Always `image_generation_call`.
        result:
          anyOf:
          - type: string
          - type: 'null'
          title: Result
          description: The generated image encoded in base64.
      type: object
      required:
      - id
      - status
      - type
      title: ImageGenerationCallInput
      description: An image generation call as an input item.
    ImageGenerationInputImageMask:
      properties:
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: Mask image file ID.
        image_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Url
          description: Base64-encoded mask image.
      type: object
      title: ImageGenerationInputImageMask
      description: Optional mask for inpainting.
    ImageURL:
      properties:
        url:
          type: string
          minLength: 1
          title: Url
          description: Image URL string, data URI, S3 URI, or base64-encoded string.
        detail:
          anyOf:
          - type: string
            enum:
            - low
            - high
            - auto
          - type: 'null'
          title: Detail
          description: 'Image resolution: `low`, `high`, or `auto`. Default: `auto`.'
      type: object
      required:
      - url
      title: ImageURL
      description: Image URL detail for image content part.
    ImagesResponse:
      properties:
        created:
          type: integer
          minimum: 0.0
          title: Created
          description: Unix timestamp (seconds) when the image was created.
        background:
          anyOf:
          - type: string
            enum:
            - transparent
            - opaque
          - type: 'null'
          title: Background
          description: 'Background setting: `transparent` or `opaque`.'
        data:
          anyOf:
          - items:
              $ref: '#/components/schemas/Image'
            type: array
          - type: 'null'
          title: Data
          description: List of generated images.
        output_format:
          anyOf:
          - type: string
            enum:
            - png
            - jpeg
            - webp
          - type: 'null'
          title: Output Format
          description: 'Output format: `png`, `webp`, or `jpeg`.'
        quality:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
          - type: 'null'
          title: Quality
          description: Quality of the generated image.
        size:
          anyOf:
          - type: string
          - type: 'null'
          title: Size
          description: Size of the generated image.
        usage:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_images__Usage'
          - type: 'null'
          description: Token usage information for the image generation.
      additionalProperties: false
      type: object
      required:
      - created
      title: ImagesResponse
      description: OpenAI-compatible non-streaming image generation response.
    ImagesResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.images.result
          title: Object
          default: organization.usage.images.result
        images:
          type: integer
          title: Images
          description: Number of images generated.
          default: 0
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
          description: Set when grouping by source.
        size:
          anyOf:
          - type: string
          - type: 'null'
          title: Size
          description: Set when grouping by size.
      additionalProperties: false
      type: object
      title: ImagesResult
      description: Aggregated image generation usage of one time bucket.
    IncompleteDetails:
      properties:
        reason:
          anyOf:
          - type: string
            enum:
            - max_output_tokens
            - content_filter
          - type: 'null'
          title: Reason
          description: Incomplete reason.
      additionalProperties: false
      type: object
      title: IncompleteDetails
      description: Details about why the response is incomplete.
    InlineSkill:
      properties:
        description:
          type: string
          title: Description
          description: The description of the skill.
        name:
          type: string
          title: Name
          description: The name of the skill.
        source:
          $ref: '#/components/schemas/InlineSkillSource'
        type:
          type: string
          const: inline
          title: Type
          description: Defines an inline skill for this request.
      type: object
      required:
      - description
      - name
      - source
      - type
      title: InlineSkill
      description: An inline skill definition.
    InlineSkillSource:
      properties:
        data:
          type: string
          title: Data
          description: Base64-encoded skill zip bundle.
        media_type:
          type: string
          const: application/zip
          title: Media Type
          description: The media type of the inline skill payload. Must be `application/zip`.
        type:
          type: string
          const: base64
          title: Type
          description: The type of the inline skill source. Must be `base64`.
      type: object
      required:
      - data
      - media_type
      - type
      title: InlineSkillSource
      description: Inline skill payload.
    InputAudio:
      properties:
        data:
          type: string
          minLength: 1
          title: Data
          description: Base64-encoded audio data, data URI, S3 URI, or URL.
        format:
          type: string
          enum:
          - wav
          - mp3
          title: Format
          description: 'Audio format: `wav` or `mp3`.'
      type: object
      required:
      - data
      - format
      title: InputAudio
      description: Input audio descriptor.
    InputAudioTranscription:
      properties:
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: 'UNSUPPORTED: the transcript comes from the session''s own
            model. Set this object at all to receive transcription events.'
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
          description: 'UNSUPPORTED: the spoken language is detected, not declared.
            State the expected language in the session''s instructions instead.'
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
          description: 'UNSUPPORTED: the transcription takes no vocabulary hint. State
            the expected terms in the session''s instructions instead.'
      type: object
      title: InputAudioTranscription
      description: Transcription of what the caller said.
    InputMessage:
      properties:
        content:
          items:
            oneOf:
            - $ref: '#/components/schemas/ResponseInputText'
            - $ref: '#/components/schemas/ResponseInputImage'
            - $ref: '#/components/schemas/ResponseInputFile'
            - $ref: '#/components/schemas/ResponseOutputTextContent'
            discriminator:
              propertyName: type
              mapping:
                input_file: '#/components/schemas/ResponseInputFile'
                input_image: '#/components/schemas/ResponseInputImage'
                input_text: '#/components/schemas/ResponseInputText'
                output_text: '#/components/schemas/ResponseOutputTextContent'
          type: array
          title: Content
          description: Input content items.
        role:
          type: string
          enum:
          - user
          - system
          - developer
          title: Role
          description: 'Message role: `user`, `system`, or `developer`.'
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Message item ID.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: 'Item status: `in_progress`, `completed`, or `incomplete`.'
        type:
          anyOf:
          - type: string
            const: message
          - type: 'null'
          title: Type
          description: Message input type.
      type: object
      required:
      - content
      - role
      title: InputMessage
      description: 'A message input with a restricted set of roles (no `assistant`).


        Accepts the echoed ``id`` for the same reason as :class:`EasyInputMessage`.'
    InputTokenCountParams:
      properties:
        model:
          type: string
          title: Model
          description: Model ID. Wildcard patterns are accepted and select the most
            recent matching model.
        input:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Input'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Input'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Input
          description: Text, image, or file inputs.
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
          description: System message. Not carried over with previous_response_id.
        tools:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
              - $ref: '#/components/schemas/FileSearchTool'
              - $ref: '#/components/schemas/ComputerTool'
              - $ref: '#/components/schemas/ComputerUsePreviewTool'
              - $ref: '#/components/schemas/WebSearchTool'
              - $ref: '#/components/schemas/Mcp'
              - $ref: '#/components/schemas/CodeInterpreter'
              - $ref: '#/components/schemas/ImageGeneration'
              - $ref: '#/components/schemas/LocalShell'
              - $ref: '#/components/schemas/FunctionShellTool'
              - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
              - $ref: '#/components/schemas/NamespaceTool'
              - $ref: '#/components/schemas/ToolSearchTool'
              - $ref: '#/components/schemas/WebSearchPreviewTool'
              - $ref: '#/components/schemas/ApplyPatchTool'
              - $ref: '#/components/schemas/ProgrammaticToolCalling'
              discriminator:
                propertyName: type
                mapping:
                  apply_patch: '#/components/schemas/ApplyPatchTool'
                  code_interpreter: '#/components/schemas/CodeInterpreter'
                  computer: '#/components/schemas/ComputerTool'
                  computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                  custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                  file_search: '#/components/schemas/FileSearchTool'
                  function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                  image_generation: '#/components/schemas/ImageGeneration'
                  local_shell: '#/components/schemas/LocalShell'
                  mcp: '#/components/schemas/Mcp'
                  namespace: '#/components/schemas/NamespaceTool'
                  programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                  shell: '#/components/schemas/FunctionShellTool'
                  tool_search: '#/components/schemas/ToolSearchTool'
                  web_search: '#/components/schemas/WebSearchTool'
                  web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                  web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                  web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
            type: array
          - type: 'null'
          title: Tools
          description: Available tools.
        tool_choice:
          anyOf:
          - type: string
            enum:
            - none
            - auto
            - required
          - $ref: '#/components/schemas/ToolChoiceAllowed'
          - $ref: '#/components/schemas/ToolChoiceTypes'
          - $ref: '#/components/schemas/ToolChoiceFunction'
          - $ref: '#/components/schemas/ToolChoiceMcp'
          - $ref: '#/components/schemas/ToolChoiceCustom'
          - $ref: '#/components/schemas/ToolChoiceApplyPatch'
          - $ref: '#/components/schemas/ToolChoiceShell'
          - $ref: '#/components/schemas/ToolChoiceProgrammaticToolCalling'
          - type: 'null'
          title: Tool Choice
          description: Tool selection.
        parallel_tool_calls:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Parallel Tool Calls
          description: Allow parallel tool calls.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/Reasoning'
          - type: 'null'
          description: Reasoning configuration.
        text:
          anyOf:
          - $ref: '#/components/schemas/ResponseTextConfig'
          - type: 'null'
          description: 'Text response config.

            UNSUPPORTED on this implementation.'
        truncation:
          anyOf:
          - type: string
            enum:
            - auto
            - disabled
          - type: 'null'
          title: Truncation
          description: '`auto` counts only what a response would keep of an input
            larger than the model''s context window, its oldest turns dropped.'
        previous_response_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Response Id
          description: 'Previous response ID for multi-turn.

            UNSUPPORTED on this implementation.'
        conversation:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ConversationObject'
          - type: 'null'
          title: Conversation
          description: The conversation whose items are counted ahead of `input`.
            Cannot be used with `previous_response_id`.
        personality:
          anyOf:
          - type: string
          - type: 'null'
          title: Personality
          description: Personality preset applied to the model. Accepted for compatibility
            and ignored.
      type: object
      required:
      - model
      title: InputTokenCountParams
      description: 'Request body for POST /v1/responses/input_tokens.


        Counts input tokens without producing a response.'
    InputTokenCountResponse:
      properties:
        object:
          type: string
          const: response.input_tokens
          title: Object
          default: response.input_tokens
        input_tokens:
          type: integer
          title: Input Tokens
          description: Total input token count.
      additionalProperties: false
      type: object
      required:
      - input_tokens
      title: InputTokenCountResponse
      description: Response body for POST /v1/responses/input_tokens.
    InputTokensClearAtLeastParam:
      properties:
        type:
          type: string
          const: input_tokens
          title: Type
          description: Threshold type.
        value:
          type: integer
          minimum: 0.0
          title: Value
          description: Input tokens to clear at least.
      type: object
      required:
      - type
      - value
      title: InputTokensClearAtLeastParam
      description: Minimum amount of input tokens a context edit must clear.
    InputTokensDetails:
      properties:
        cached_tokens:
          type: integer
          title: Cached Tokens
          description: Cached token count.
        cache_write_tokens:
          type: integer
          title: Cache Write Tokens
          description: Cache write token count.
          default: 0
      additionalProperties: false
      type: object
      required:
      - cached_tokens
      title: InputTokensDetails
      description: A detailed breakdown of the input tokens.
    InputTokensTriggerParam:
      properties:
        type:
          type: string
          const: input_tokens
          title: Type
          description: Trigger type.
        value:
          type: integer
          minimum: 1.0
          title: Value
          description: Input tokens that trigger the edit.
      type: object
      required:
      - type
      - value
      title: InputTokensTriggerParam
      description: Context editing trigger on the prompt size.
    ItemReference:
      properties:
        id:
          type: string
          title: Id
          description: The ID of the item to reference.
        type:
          anyOf:
          - type: string
            const: item_reference
          - type: 'null'
          title: Type
          description: The type of item to reference. Always `item_reference`.
      type: object
      required:
      - id
      title: ItemReference
      description: An internal identifier for an item to reference.
    JSONOutputFormatParam:
      properties:
        type:
          type: string
          const: json_schema
          title: Type
          description: Output format type. Always `json_schema`.
        schema:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Schema
          description: The JSON schema of the format.
      type: object
      required:
      - type
      - schema
      title: JSONOutputFormatParam
      description: JSON output format configuration.
    JSONSchema:
      properties:
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Whether to enable strict schema adherence when generating the
            function call. If true, the model follows the exact schema in `parameters`;
            only a subset of JSON Schema is supported in that case.
        name:
          type: string
          title: Name
          description: The name of the response format (max 64 chars).
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: A description of what the response format is for, used by the
            model to determine how to respond in the format.
        schema:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Schema
          description: The schema for the response format, described as a JSON Schema
            object.
      type: object
      required:
      - name
      - schema
      title: JSONSchema
      description: Structured Outputs JSON Schema options.
    JsonValue: {}
    LastError:
      properties:
        code:
          type: string
          enum:
          - server_error
          - unsupported_file
          - invalid_file
          title: Code
          description: The error category.
        message:
          type: string
          title: Message
          description: Human-readable description of the failure.
      additionalProperties: false
      type: object
      required:
      - code
      - message
      title: LastError
      description: Why a file failed to be indexed.
    LegacyFunction:
      properties:
        name:
          type: string
          title: Name
          description: The name of the function to be called.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: A description of what the function does.
        parameters:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Parameters
          description: The parameters the function accepts, described as a JSON Schema
            object. Omitting `parameters` defines a function with an empty parameter
            list.
      type: object
      required:
      - name
      title: LegacyFunction
      description: Legacy function definition (deprecated in favor of tools).
    ListFilesResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/FileObject'
          type: array
          title: Data
          description: List of File objects.
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          type: string
          title: First Id
          description: ID of the first file in the list, or '' when empty.
        last_id:
          type: string
          title: Last Id
          description: ID of the last file in the list, or '' when empty.
      additionalProperties: false
      type: object
      required:
      - data
      - has_more
      - first_id
      - last_id
      title: ListFilesResponse
      description: Paginated list of files returned by GET /v1/files.
    ListResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/ModelSummary'
          type: array
          title: Models
          description: Available models.
      additionalProperties: false
      type: object
      required:
      - models
      title: ListResponse
      description: Model list response.
    ListVectorStoreFilesResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: Always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/VectorStoreFile'
          type: array
          title: Data
          description: The files in this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first file in the page.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last file in the page.
        has_more:
          type: boolean
          title: Has More
          description: Whether more files follow this page.
      additionalProperties: false
      type: object
      required:
      - data
      - has_more
      title: ListVectorStoreFilesResponse
      description: One page of vector store files.
    ListVectorStoresResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: Always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/VectorStore'
          type: array
          title: Data
          description: The vector stores in this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first store in the page.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last store in the page.
        has_more:
          type: boolean
          title: Has More
          description: Whether more stores follow this page.
      additionalProperties: false
      type: object
      required:
      - data
      - has_more
      title: ListVectorStoresResponse
      description: One page of vector stores.
    LocalEnvironment:
      properties:
        type:
          type: string
          const: local
          title: Type
          description: Local environment.
        skills:
          anyOf:
          - items:
              $ref: '#/components/schemas/LocalSkill'
            type: array
          - type: 'null'
          title: Skills
          description: List of skills.
      type: object
      required:
      - type
      title: LocalEnvironment
      description: Use a local computer environment.
    LocalShell:
      properties:
        type:
          type: string
          const: local_shell
          title: Type
          description: Local shell tool type.
      type: object
      required:
      - type
      title: LocalShell
      description: 'A tool that allows the model to execute shell commands in a local
        environment.


        UNSUPPORTED on this implementation.'
    LocalShellCall:
      properties:
        id:
          type: string
          title: Id
          description: Local shell call ID.
        action:
          $ref: '#/components/schemas/LocalShellCallAction'
          description: Shell command to execute.
        call_id:
          type: string
          title: Call Id
          description: Model-generated call ID.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Call status.
        type:
          type: string
          const: local_shell_call
          title: Type
          description: Local shell call type.
      additionalProperties: false
      type: object
      required:
      - id
      - action
      - call_id
      - status
      - type
      title: LocalShellCall
      description: A tool call to run a command on the local shell.
    LocalShellCallAction:
      properties:
        command:
          items:
            type: string
          type: array
          title: Command
          description: Command to run.
        env:
          additionalProperties:
            type: string
          type: object
          title: Env
          description: Environment variables.
        type:
          type: string
          const: exec
          title: Type
          description: Exec action type.
        timeout_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Timeout Ms
          description: Timeout in milliseconds.
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: User to run as.
        working_directory:
          anyOf:
          - type: string
          - type: 'null'
          title: Working Directory
          description: Working directory.
      additionalProperties: false
      type: object
      required:
      - command
      - env
      - type
      title: LocalShellCallAction
      description: Execute a shell command on the server.
    LocalShellCallActionInput:
      properties:
        command:
          items:
            type: string
          type: array
          title: Command
          description: Command to run.
        env:
          additionalProperties:
            type: string
          type: object
          title: Env
          description: Environment variables.
        type:
          type: string
          const: exec
          title: Type
          description: Exec action type.
        timeout_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Timeout Ms
          description: Timeout in milliseconds.
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: User to run as.
        working_directory:
          anyOf:
          - type: string
          - type: 'null'
          title: Working Directory
          description: Working directory.
      type: object
      required:
      - command
      - env
      - type
      title: LocalShellCallActionInput
      description: Execute a shell command on the server.
    LocalShellCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the local shell call.
        action:
          $ref: '#/components/schemas/LocalShellCallActionInput'
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the local shell tool call generated by the
            model.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the local shell call.
        type:
          type: string
          const: local_shell_call
          title: Type
          description: The type of the local shell call. Always `local_shell_call`.
      type: object
      required:
      - id
      - action
      - call_id
      - status
      - type
      title: LocalShellCallInput
      description: A tool call to run a command on the local shell (as input item).
    LocalShellCallOutput:
      properties:
        id:
          type: string
          title: Id
          description: Shell tool call ID.
        output:
          type: string
          title: Output
          description: JSON output string.
        type:
          type: string
          const: local_shell_call_output
          title: Type
          description: Shell call output type.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: Item status.
      additionalProperties: false
      type: object
      required:
      - id
      - output
      - type
      title: LocalShellCallOutput
      description: The output of a local shell tool call.
    LocalShellCallOutputInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the local shell tool call generated by the
            model.
        output:
          type: string
          title: Output
          description: A JSON string of the output of the local shell tool call.
        type:
          type: string
          const: local_shell_call_output
          title: Type
          description: The type of the local shell tool call output. Always `local_shell_call_output`.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the item. One of `in_progress`, `completed`,
            or `incomplete`.
      type: object
      required:
      - id
      - output
      - type
      title: LocalShellCallOutputInput
      description: The output of a local shell tool call (as input item).
    LocalSkill:
      properties:
        description:
          type: string
          title: Description
          description: The description of the skill.
        name:
          type: string
          title: Name
          description: The name of the skill.
        path:
          type: string
          title: Path
          description: The path to the directory containing the skill.
      type: object
      required:
      - description
      - name
      - path
      title: LocalSkill
      description: A local skill for a shell environment.
    Logprob:
      properties:
        token:
          type: string
          title: Token
          description: Text token.
        bytes:
          items:
            type: integer
          type: array
          title: Bytes
          description: Token bytes.
        logprob:
          type: number
          title: Logprob
          description: Log probability.
        top_logprobs:
          items:
            $ref: '#/components/schemas/LogprobTopLogprob'
          type: array
          title: Top Logprobs
          description: Top log probabilities.
      additionalProperties: false
      type: object
      required:
      - token
      - bytes
      - logprob
      - top_logprobs
      title: Logprob
      description: The log probability of a token.
    LogprobTopLogprob:
      properties:
        token:
          anyOf:
          - type: string
          - type: 'null'
          title: Token
          description: Possible text token.
        logprob:
          anyOf:
          - type: number
          - type: 'null'
          title: Logprob
          description: Log probability.
      additionalProperties: false
      type: object
      title: LogprobTopLogprob
      description: A possible token with its log probability.
    MCPServerToolConfigurationParam:
      properties:
        allowed_tools:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Tools
          description: Tool names the model may call, instead of all of them.
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          description: Whether the server's tools are usable.
      type: object
      title: MCPServerToolConfigurationParam
      description: Which tools of a remote MCP server the model may use.
    MCPServerURLDefinitionParam:
      properties:
        type:
          type: string
          const: url
          title: Type
          description: Server type. Always `url`.
        name:
          type: string
          title: Name
          description: Name an `mcp_toolset` entry references to configure this server.
        url:
          type: string
          title: Url
          description: HTTPS endpoint of the MCP server.
        authorization_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization Token
          description: 'Bearer token for the MCP server.

            UNSUPPORTED on this implementation: no connection to the server is made,
            so the token is never forwarded to any backend.'
        tool_configuration:
          anyOf:
          - $ref: '#/components/schemas/MCPServerToolConfigurationParam'
          - type: 'null'
          description: Which of the server's tools the model may use.
      type: object
      required:
      - type
      - name
      - url
      title: MCPServerURLDefinitionParam
      description: 'Connection details of a remote MCP server.


        UNSUPPORTED on this implementation: accepted and ignored, and the rest of
        the

        request is served normally. The model never connects to the server, so its

        tools never run.'
    MCPToolConfigParam:
      properties:
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Load the tool only when it is referenced.
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          description: Whether the tool is usable.
      type: object
      title: MCPToolConfigParam
      description: Configuration of the tools an MCP toolset exposes.
    MCPToolsetParam:
      properties:
        type:
          type: string
          const: mcp_toolset
          title: Type
          description: Tool type. Always `mcp_toolset`.
        mcp_server_name:
          type: string
          title: Mcp Server Name
          description: Name of the `mcp_servers` entry whose tools this configures.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this tool.
        configs:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/MCPToolConfigParam'
            type: object
          - type: 'null'
          title: Configs
          description: Per-tool configuration, keyed by tool name.
        default_config:
          anyOf:
          - $ref: '#/components/schemas/MCPToolConfigParam'
          - type: 'null'
          description: Configuration applied to every tool of the server.
      type: object
      required:
      - type
      - mcp_server_name
      title: MCPToolsetParam
      description: 'Tools of one remote MCP server declared in `mcp_servers`.


        UNSUPPORTED on this implementation: accepted and ignored, and no other tool

        in the request is affected. The model never connects to a remote MCP server,

        so none of these tools can be called; declare the tools you need in `tools`

        and run them yourself.'
    Mcp:
      properties:
        server_label:
          type: string
          title: Server Label
          description: Label for this MCP server.
        type:
          type: string
          const: mcp
          title: Type
          description: MCP tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
        allowed_tools:
          anyOf:
          - items:
              type: string
            type: array
          - $ref: '#/components/schemas/McpAllowedToolsFilter'
          - type: 'null'
          title: Allowed Tools
          description: Allowed tool names or filter.
        authorization:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
          description: OAuth access token for the MCP server.
        connector_id:
          anyOf:
          - type: string
            enum:
            - connector_dropbox
            - connector_gmail
            - connector_googlecalendar
            - connector_googledrive
            - connector_microsoftteams
            - connector_outlookcalendar
            - connector_outlookemail
            - connector_sharepoint
          - type: 'null'
          title: Connector Id
          description: Service connector. Requires `server_url` or `connector_id`.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Deferred and discovered via tool search.
        headers:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Headers
          description: HTTP headers for the MCP server.
        require_approval:
          anyOf:
          - $ref: '#/components/schemas/McpRequireApprovalFilter'
          - type: string
            enum:
            - always
            - never
          - type: 'null'
          title: Require Approval
          description: Tools requiring approval.
        server_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Server Description
          description: MCP server description.
        server_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Server Url
          description: MCP server URL. Requires `server_url` or `connector_id`.
        tunnel_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Tunnel Id
          description: Tunnel ID for connecting to a local MCP server.
      type: object
      required:
      - server_label
      - type
      title: Mcp
      description: 'Give the model access to additional tools via remote Model Context
        Protocol (MCP) servers.


        UNSUPPORTED on this implementation.'
    McpAllowedToolsFilter:
      properties:
        read_only:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Read Only
          description: Filter by read-only status.
        tool_names:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tool Names
          description: List of allowed tool names.
      type: object
      title: McpAllowedToolsFilter
      description: A filter object to specify which MCP tools are allowed.
    McpApprovalRequest:
      properties:
        id:
          type: string
          title: Id
          description: Approval request ID.
        arguments:
          type: string
          title: Arguments
          description: Tool arguments JSON.
        name:
          type: string
          title: Name
          description: Tool name.
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        type:
          type: string
          const: mcp_approval_request
          title: Type
          description: MCP approval request type.
      additionalProperties: false
      type: object
      required:
      - id
      - arguments
      - name
      - server_label
      - type
      title: McpApprovalRequest
      description: A request for human approval of a tool invocation.
    McpApprovalRequestInput:
      properties:
        id:
          type: string
          title: Id
          description: Approval request ID.
        arguments:
          type: string
          title: Arguments
          description: Tool arguments JSON.
        name:
          type: string
          title: Name
          description: Tool name.
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        type:
          type: string
          const: mcp_approval_request
          title: Type
          description: MCP approval request type.
      type: object
      required:
      - id
      - arguments
      - name
      - server_label
      - type
      title: McpApprovalRequestInput
      description: A request for human approval of a tool invocation (as input item).
    McpApprovalResponse:
      properties:
        approval_request_id:
          type: string
          title: Approval Request Id
          description: The ID of the approval request being answered.
        approve:
          type: boolean
          title: Approve
          description: Whether the request was approved.
        type:
          type: string
          const: mcp_approval_response
          title: Type
          description: The type of the item. Always `mcp_approval_response`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the approval response.
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Optional reason for the decision.
      type: object
      required:
      - approval_request_id
      - approve
      - type
      title: McpApprovalResponse
      description: A response to an MCP approval request.
    McpApprovalResponseOutput:
      properties:
        id:
          type: string
          title: Id
          description: Approval response ID.
        approval_request_id:
          type: string
          title: Approval Request Id
          description: Approval request ID.
        approve:
          type: boolean
          title: Approve
          description: Whether approved.
        type:
          type: string
          const: mcp_approval_response
          title: Type
          description: MCP approval response type.
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Decision reason.
      additionalProperties: false
      type: object
      required:
      - id
      - approval_request_id
      - approve
      - type
      title: McpApprovalResponseOutput
      description: A response to an MCP approval request.
    McpCall:
      properties:
        id:
          type: string
          title: Id
          description: Tool call ID.
        arguments:
          type: string
          title: Arguments
          description: Tool arguments JSON.
        name:
          type: string
          title: Name
          description: Tool name.
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        type:
          type: string
          const: mcp_call
          title: Type
          description: MCP call type.
        approval_request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Approval Request Id
          description: Approval request ID.
        error:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/McpProtocolError'
            - $ref: '#/components/schemas/McpToolExecutionError'
            - $ref: '#/components/schemas/McpHTTPError'
            discriminator:
              propertyName: type
              mapping:
                http_error: '#/components/schemas/McpHTTPError'
                mcp_protocol_error: '#/components/schemas/McpProtocolError'
                mcp_tool_execution_error: '#/components/schemas/McpToolExecutionError'
          - type: string
          - type: 'null'
          title: Error
          description: Tool call error.
        output:
          anyOf:
          - type: string
          - type: 'null'
          title: Output
          description: Tool call output.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
            - calling
            - failed
          - type: 'null'
          title: Status
          description: Tool call status.
      additionalProperties: false
      type: object
      required:
      - id
      - arguments
      - name
      - server_label
      - type
      title: McpCall
      description: An invocation of a tool on an MCP server.
    McpCallInput:
      properties:
        id:
          type: string
          title: Id
          description: Tool call ID.
        arguments:
          type: string
          title: Arguments
          description: Tool arguments JSON.
        name:
          type: string
          title: Name
          description: Tool name.
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        type:
          type: string
          const: mcp_call
          title: Type
          description: MCP call type.
        approval_request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Approval Request Id
          description: Approval request ID.
        error:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/McpProtocolErrorInput'
            - $ref: '#/components/schemas/McpToolExecutionErrorInput'
            - $ref: '#/components/schemas/McpHTTPErrorInput'
            discriminator:
              propertyName: type
              mapping:
                http_error: '#/components/schemas/McpHTTPErrorInput'
                mcp_protocol_error: '#/components/schemas/McpProtocolErrorInput'
                mcp_tool_execution_error: '#/components/schemas/McpToolExecutionErrorInput'
          - type: string
          - type: 'null'
          title: Error
          description: Tool call error; an object upstream, a string from older clients.
        output:
          anyOf:
          - type: string
          - type: 'null'
          title: Output
          description: Tool call output.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
            - calling
            - failed
          - type: 'null'
          title: Status
          description: Tool call status.
      type: object
      required:
      - id
      - arguments
      - name
      - server_label
      - type
      title: McpCallInput
      description: An invocation of a tool on an MCP server (as input item).
    McpHTTPError:
      properties:
        code:
          type: integer
          title: Code
          description: The HTTP status code.
        message:
          type: string
          title: Message
          description: The error message.
        type:
          type: string
          const: http_error
          title: Type
          description: The error type. Always `http_error`.
      additionalProperties: false
      type: object
      required:
      - code
      - message
      - type
      title: McpHTTPError
      description: An HTTP error returned by the MCP server.
    McpHTTPErrorInput:
      properties:
        code:
          type: integer
          title: Code
          description: The HTTP status code.
        message:
          type: string
          title: Message
          description: The error message.
        type:
          type: string
          const: http_error
          title: Type
          description: The error type. Always `http_error`.
      type: object
      required:
      - code
      - message
      - type
      title: McpHTTPErrorInput
      description: An HTTP error returned by the MCP server (as input item).
    McpListTools:
      properties:
        id:
          type: string
          title: Id
          description: List ID.
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        tools:
          items:
            $ref: '#/components/schemas/McpListToolsToolOutput'
          type: array
          title: Tools
          description: Server tools.
        type:
          type: string
          const: mcp_list_tools
          title: Type
          description: MCP list tools type.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Error if tools could not be listed.
      additionalProperties: false
      type: object
      required:
      - id
      - server_label
      - tools
      - type
      title: McpListTools
      description: A list of tools available on an MCP server.
    McpListToolsInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the list.
        server_label:
          type: string
          title: Server Label
          description: The label of the MCP server.
        tools:
          items:
            $ref: '#/components/schemas/McpListToolsToolItem'
          type: array
          title: Tools
          description: The tools available on the server.
        type:
          type: string
          const: mcp_list_tools
          title: Type
          description: The type of the item. Always `mcp_list_tools`.
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: Error message if the server could not list tools.
      type: object
      required:
      - id
      - server_label
      - tools
      - type
      title: McpListToolsInput
      description: A list of tools available on an MCP server (as input item).
    McpListToolsToolItem:
      properties:
        input_schema:
          title: Input Schema
          description: Tool input JSON schema.
        name:
          type: string
          title: Name
          description: Tool name.
        annotations:
          anyOf:
          - {}
          - type: 'null'
          title: Annotations
          description: Tool annotations.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Tool description.
      type: object
      required:
      - input_schema
      - name
      title: McpListToolsToolItem
      description: A tool available on an MCP server.
    McpListToolsToolOutput:
      properties:
        input_schema:
          title: Input Schema
          description: Tool input JSON schema.
        name:
          type: string
          title: Name
          description: Tool name.
        annotations:
          anyOf:
          - {}
          - type: 'null'
          title: Annotations
          description: Tool annotations.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Tool description.
      additionalProperties: false
      type: object
      required:
      - input_schema
      - name
      title: McpListToolsToolOutput
      description: A tool available on an MCP server.
    McpProtocolError:
      properties:
        code:
          type: integer
          title: Code
          description: The MCP protocol error code.
        message:
          type: string
          title: Message
          description: The error message.
        type:
          type: string
          const: mcp_protocol_error
          title: Type
          description: The error type. Always `mcp_protocol_error`.
      additionalProperties: false
      type: object
      required:
      - code
      - message
      - type
      title: McpProtocolError
      description: An MCP protocol error returned by the server.
    McpProtocolErrorInput:
      properties:
        code:
          type: integer
          title: Code
          description: The MCP protocol error code.
        message:
          type: string
          title: Message
          description: The error message.
        type:
          type: string
          const: mcp_protocol_error
          title: Type
          description: The error type. Always `mcp_protocol_error`.
      type: object
      required:
      - code
      - message
      - type
      title: McpProtocolErrorInput
      description: An MCP protocol error returned by the server (as input item).
    McpRequireApprovalFilter:
      properties:
        always:
          anyOf:
          - $ref: '#/components/schemas/McpToolFilter'
          - type: 'null'
          description: A filter object to specify which tools always require approval.
        never:
          anyOf:
          - $ref: '#/components/schemas/McpToolFilter'
          - type: 'null'
          description: A filter object to specify which tools never require approval.
      type: object
      title: McpRequireApprovalFilter
      description: Specify which of the MCP server's tools require approval.
    McpServerTool:
      properties:
        type:
          type: string
          const: mcp
          title: Type
          description: Kind of tool being declared.
        server_label:
          anyOf:
          - type: string
          - type: 'null'
          title: Server Label
          description: Name the remote server is referred to by.
      type: object
      required:
      - type
      title: McpServerTool
      description: 'UNSUPPORTED: a remote MCP server the session would call tools
        on.'
    McpToolChoice:
      properties:
        type:
          type: string
          const: mcp
          title: Type
          description: Kind of tool being named.
        server_label:
          type: string
          title: Server Label
          description: Name the remote server is referred to by.
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of that server's tool, if only one is meant.
      type: object
      required:
      - type
      - server_label
      title: McpToolChoice
      description: 'UNSUPPORTED: a remote MCP server''s tool every answer would start
        with.'
    McpToolExecutionError:
      properties:
        content:
          title: Content
          description: The error content returned by the tool.
        type:
          type: string
          const: mcp_tool_execution_error
          title: Type
          description: The error type. Always `mcp_tool_execution_error`.
      additionalProperties: false
      type: object
      required:
      - content
      - type
      title: McpToolExecutionError
      description: An error raised while the MCP tool was executing.
    McpToolExecutionErrorInput:
      properties:
        content:
          title: Content
          description: The error content returned by the tool.
        type:
          type: string
          const: mcp_tool_execution_error
          title: Type
          description: The error type. Always `mcp_tool_execution_error`.
      type: object
      required:
      - content
      - type
      title: McpToolExecutionErrorInput
      description: An error raised while the MCP tool was executing (as input item).
    McpToolFilter:
      properties:
        read_only:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Read Only
          description: Filter by read-only status.
        tool_names:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tool Names
          description: List of tool names.
      type: object
      title: McpToolFilter
      description: Filter specifying a set of MCP tools by name or read-only status.
    MemoryToolParam:
      properties:
        name:
          type: string
          const: memory
          title: Name
          description: Tool name.
        type:
          type: string
          pattern: ^memory(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        input_examples:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Input Examples
          description: Example inputs.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - name
      - type
      title: MemoryToolParam
      description: Memory tool parameter.
    Message:
      properties:
        id:
          type: string
          title: Id
          description: Unique object identifier. Format and length may change over
            time.
        type:
          type: string
          const: message
          title: Type
          description: Object type. Always `message`.
        role:
          type: string
          const: assistant
          title: Role
          description: Conversational role of the generated message. Always `assistant`.
        content:
          items:
            oneOf:
            - $ref: '#/components/schemas/TextBlock'
            - $ref: '#/components/schemas/ThinkingBlock'
            - $ref: '#/components/schemas/RedactedThinkingBlock'
            - $ref: '#/components/schemas/ToolUseBlock'
            - $ref: '#/components/schemas/ServerToolUseBlock'
            - $ref: '#/components/schemas/WebSearchToolResultBlock'
            - $ref: '#/components/schemas/WebFetchToolResultBlock'
            - $ref: '#/components/schemas/CodeExecutionToolResultBlock'
            - $ref: '#/components/schemas/BashCodeExecutionToolResultBlock'
            - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlock'
            - $ref: '#/components/schemas/ToolSearchToolResultBlock'
            - $ref: '#/components/schemas/ContainerUploadBlock'
            discriminator:
              propertyName: type
              mapping:
                bash_code_execution_tool_result: '#/components/schemas/BashCodeExecutionToolResultBlock'
                code_execution_tool_result: '#/components/schemas/CodeExecutionToolResultBlock'
                container_upload: '#/components/schemas/ContainerUploadBlock'
                redacted_thinking: '#/components/schemas/RedactedThinkingBlock'
                server_tool_use: '#/components/schemas/ServerToolUseBlock'
                text: '#/components/schemas/TextBlock'
                text_editor_code_execution_tool_result: '#/components/schemas/TextEditorCodeExecutionToolResultBlock'
                thinking: '#/components/schemas/ThinkingBlock'
                tool_search_tool_result: '#/components/schemas/ToolSearchToolResultBlock'
                tool_use: '#/components/schemas/ToolUseBlock'
                web_fetch_tool_result: '#/components/schemas/WebFetchToolResultBlock'
                web_search_tool_result: '#/components/schemas/WebSearchToolResultBlock'
          type: array
          title: Content
          description: Content generated by the model, as an array of content blocks
            each with a `type`. If the input `messages` ended with an `assistant`
            turn, this continues directly from that turn.
        model:
          type: string
          title: Model
          description: Model ID.
        stop_reason:
          anyOf:
          - type: string
            enum:
            - end_turn
            - max_tokens
            - stop_sequence
            - tool_use
            - pause_turn
            - refusal
            - model_context_window_exceeded
          - type: 'null'
          title: Stop Reason
          description: 'Why generation stopped: `end_turn` (natural stop), `max_tokens`
            (hit the limit), `stop_sequence` (matched a custom stop sequence), `tool_use`
            (model invoked a tool), `pause_turn` (long-running turn paused — resend
            as-is to continue), or `refusal` (streaming classifier intervened). Always
            non-null except in the streaming `message_start` event.'
        stop_details:
          anyOf:
          - $ref: '#/components/schemas/RefusalStopDetails'
          - type: 'null'
          description: Structured information about a refusal, present when `stop_reason`
            is `refusal`.
        stop_sequence:
          anyOf:
          - type: string
          - type: 'null'
          title: Stop Sequence
          description: The matched custom stop sequence, if any.
        usage:
          $ref: '#/components/schemas/stdapi__types__anthropic_messages__Usage'
          description: Cumulative billing/rate-limit token usage. May not match the
            visible content one-to-one; total input tokens = `input_tokens` + `cache_creation_input_tokens`
            + `cache_read_input_tokens`.
        container:
          anyOf:
          - $ref: '#/components/schemas/Container'
          - type: 'null'
          description: Information about the container used in the request (for the
            code execution tool).
        context_management:
          anyOf:
          - $ref: '#/components/schemas/ContextManagementResponse'
          - type: 'null'
          description: Context edits applied to the prompt; present when context management
            is enabled on a Claude model.
      additionalProperties: false
      type: object
      required:
      - id
      - type
      - role
      - content
      - model
      - usage
      title: Message
      description: Messages API response.
    MessageBatch:
      properties:
        id:
          type: string
          title: Id
          description: Unique object identifier of the Message Batch.
        type:
          type: string
          const: message_batch
          title: Type
          description: Object type. Always `message_batch`.
          default: message_batch
        processing_status:
          type: string
          enum:
          - in_progress
          - canceling
          - ended
          title: Processing Status
          description: Processing status of the Message Batch.
        request_counts:
          $ref: '#/components/schemas/MessageBatchRequestCounts'
          description: Tallies of the requests in the batch, by status.
        created_at:
          type: string
          title: Created At
          description: RFC 3339 datetime string of the Message Batch creation time.
        expires_at:
          type: string
          title: Expires At
          description: RFC 3339 datetime string of the time at which the Message Batch
            stops being processed, 24 hours after creation.
        ended_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Ended At
          description: RFC 3339 datetime string of the time processing ended. Set
            only once every request has succeeded, errored, been canceled or expired.
        archived_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Archived At
          description: RFC 3339 datetime string of the time the Message Batch was
            archived and its results became unavailable.
        cancel_initiated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Cancel Initiated At
          description: RFC 3339 datetime string of the time cancellation was initiated.
            Set only if cancellation was initiated.
        results_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Results Url
          description: URL of the `.jsonl` file holding the results of the batch's
            requests. Set only once processing has ended. Results are not guaranteed
            to be in request order — match them with `custom_id`.
      additionalProperties: false
      type: object
      required:
      - id
      - processing_status
      - request_counts
      - created_at
      - expires_at
      title: MessageBatch
      description: A batch of Messages API requests processed asynchronously.
    MessageBatchCreateParams:
      properties:
        requests:
          items:
            $ref: '#/components/schemas/MessageBatchRequest'
          type: array
          minItems: 1
          title: Requests
          description: The requests to run. Each is an individual Messages API request
            with its own `custom_id` and parameters.
      type: object
      required:
      - requests
      title: MessageBatchCreateParams
      description: Message Batch creation parameters (Anthropic Message Batches API).
    MessageBatchList:
      properties:
        data:
          items:
            $ref: '#/components/schemas/MessageBatch'
          type: array
          title: Data
          description: List of Message Batch objects.
        has_more:
          type: boolean
          title: Has More
          description: Whether more Message Batches exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first Message Batch in this page, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last Message Batch in this page, or null when empty.
      additionalProperties: false
      type: object
      required:
      - data
      - has_more
      title: MessageBatchList
      description: Paginated list of Message Batches.
    MessageBatchRequest:
      properties:
        custom_id:
          type: string
          pattern: ^[a-zA-Z0-9_-]{1,64}$
          title: Custom Id
          description: Identifier you choose for this request, unique within the batch.
            Results may come back in any order, so this is how a result is matched
            back to its request.
        params:
          $ref: '#/components/schemas/MessageCreateParams'
          description: The Messages API parameters for this request, exactly as they
            would be sent to `anthropic_message`.
      type: object
      required:
      - custom_id
      - params
      title: MessageBatchRequest
      description: One request within a Message Batch.
    MessageBatchRequestCounts:
      properties:
        processing:
          type: integer
          title: Processing
          description: Number of requests still being processed.
        succeeded:
          type: integer
          title: Succeeded
          description: Number of requests that completed successfully.
        errored:
          type: integer
          title: Errored
          description: Number of requests that errored.
        canceled:
          type: integer
          title: Canceled
          description: Number of requests that were canceled. Known only once processing
            of the whole batch has ended.
        expired:
          type: integer
          title: Expired
          description: Number of requests that expired. Known only once processing
            of the whole batch has ended.
      additionalProperties: false
      type: object
      required:
      - processing
      - succeeded
      - errored
      - canceled
      - expired
      title: MessageBatchRequestCounts
      description: Counts of requests in the Message Batch, by status.
    MessageCountTokensParams:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: Model ID. Wildcard patterns are accepted and select the most
            recent matching model.
        messages:
          items:
            $ref: '#/components/schemas/MessageParam'
          type: array
          title: Messages
          description: Conversation turns, alternating `user`/`assistant` roles. Consecutive
            turns with the same role are combined. If the final message has role `assistant`,
            the response continues from its content. A `content` value may be a plain
            string (shorthand for one `text` block) or an array of content blocks.
            A first message with role `system` sets an inline system prompt, appended
            after the top-level `system` parameter. `mcp_tool_use` and `mcp_tool_result`
            blocks are accepted and read as `tool_use` and `tool_result`.
        system:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/TextBlockParam'
            type: array
          - type: 'null'
          title: System
          description: System prompt providing context and instructions, such as a
            goal or role.
        mcp_servers:
          anyOf:
          - items:
              $ref: '#/components/schemas/MCPServerURLDefinitionParam'
            type: array
          - type: 'null'
          title: Mcp Servers
          description: 'Remote MCP servers to connect the model to.

            UNSUPPORTED on this implementation: accepted and ignored, and the rest
            of the request is counted normally. The model never connects to these
            servers, so their tools never run; declare the tools you need in `tools`
            and run them yourself.'
        tools:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/ToolParam'
              - $ref: '#/components/schemas/ToolBashParam'
              - $ref: '#/components/schemas/ToolTextEditorParam'
              - $ref: '#/components/schemas/ToolComputerParam'
              - $ref: '#/components/schemas/WebSearchToolParam'
              - $ref: '#/components/schemas/CodeExecutionToolParam'
              - $ref: '#/components/schemas/MemoryToolParam'
              - $ref: '#/components/schemas/WebFetchToolParam'
              - $ref: '#/components/schemas/ToolSearchToolBm25Param'
              - $ref: '#/components/schemas/ToolSearchToolRegexParam'
              - $ref: '#/components/schemas/MCPToolsetParam'
              - $ref: '#/components/schemas/BrowserToolsetParam'
              - $ref: '#/components/schemas/ComputerToolsetParam'
            type: array
          - type: 'null'
          title: Tools
          description: Tool definitions the model may use. Each includes `name`, an
            optional but recommended `description`, and `input_schema` (JSON Schema
            for the tool's `input`). The model returns `tool_use` content blocks;
            run the tool and return results via `tool_result` content blocks. Client
            tools run on your side; server tools have their own documented behavior.
        tool_choice:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ToolChoiceAutoParam'
            - $ref: '#/components/schemas/ToolChoiceAnyParam'
            - $ref: '#/components/schemas/ToolChoiceToolParam'
            - $ref: '#/components/schemas/ToolChoiceNoneParam'
            discriminator:
              propertyName: type
              mapping:
                any: '#/components/schemas/ToolChoiceAnyParam'
                auto: '#/components/schemas/ToolChoiceAutoParam'
                none: '#/components/schemas/ToolChoiceNoneParam'
                tool: '#/components/schemas/ToolChoiceToolParam'
          - type: 'null'
          title: Tool Choice
          description: 'How the model should use the provided tools: a specific tool,
            any available tool, model''s choice, or none.'
        output_config:
          anyOf:
          - $ref: '#/components/schemas/OutputConfigParam'
          - type: 'null'
          description: Configuration options for the model's output, such as the output
            format.
        thinking:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ThinkingConfigEnabledParam'
            - $ref: '#/components/schemas/ThinkingConfigDisabledParam'
            - $ref: '#/components/schemas/ThinkingConfigAdaptiveParam'
            - $ref: '#/components/schemas/ThinkingConfigBetweenToolsParam'
            discriminator:
              propertyName: type
              mapping:
                adaptive: '#/components/schemas/ThinkingConfigAdaptiveParam'
                between_tools: '#/components/schemas/ThinkingConfigBetweenToolsParam'
                disabled: '#/components/schemas/ThinkingConfigDisabledParam'
                enabled: '#/components/schemas/ThinkingConfigEnabledParam'
          - type: 'null'
          title: Thinking
          description: Extended thinking configuration. When enabled, responses include
            `thinking` content blocks showing the model's reasoning before the final
            answer.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control applied to last cacheable block.
        context_management:
          anyOf:
          - $ref: '#/components/schemas/ContextManagementConfigParam'
          - type: 'null'
          description: 'Context editing: clear older tool results or thinking blocks
            server-side once the conversation grows, keeping the full history on your
            side. Applied on Claude models; ignored on other models.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - messages
      title: MessageCountTokensParams
      description: Count tokens request for the Messages API.
    MessageCreateParams:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: Model ID. Wildcard patterns are accepted and select the most
            recent matching model.
        messages:
          items:
            $ref: '#/components/schemas/MessageParam'
          type: array
          title: Messages
          description: Conversation turns, alternating `user`/`assistant` roles. Consecutive
            turns with the same role are combined. If the final message has role `assistant`,
            the response continues from its content. A `content` value may be a plain
            string (shorthand for one `text` block) or an array of content blocks.
            A first message with role `system` sets an inline system prompt, appended
            after the top-level `system` parameter. `mcp_tool_use` and `mcp_tool_result`
            blocks are accepted and read as `tool_use` and `tool_result`.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control applied to the last cacheable block.
        context_management:
          anyOf:
          - $ref: '#/components/schemas/ContextManagementConfigParam'
          - type: 'null'
          description: 'Context editing: clear older tool results or thinking blocks
            server-side once the conversation grows, keeping the full history on your
            side. Applied on Claude models; ignored on other models.'
        max_tokens:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Max Tokens
          description: 'Maximum tokens to generate before stopping; the model may
            stop earlier. Maximum value varies by model. Optional here, unlike the
            Anthropic API: the model''s own default output limit applies when omitted,
            except on a Bedrock Mantle Claude model, whose API requires a limit and
            is given 4096. Set it to 0 to populate the prompt cache without asking
            for an answer.'
        inference_geo:
          anyOf:
          - type: string
          - type: 'null'
          title: Inference Geo
          description: 'Geographic region to run inference in.

            UNSUPPORTED on this implementation: accepted and ignored, and the rest
            of the request is served normally. Data residency is set by the deployment,
            not per request.'
        mcp_servers:
          anyOf:
          - items:
              $ref: '#/components/schemas/MCPServerURLDefinitionParam'
            type: array
          - type: 'null'
          title: Mcp Servers
          description: 'Remote MCP servers to connect the model to.

            UNSUPPORTED on this implementation: accepted and ignored, and the rest
            of the request is served normally. The model never connects to these servers,
            so their tools never run; declare the tools you need in `tools` and run
            them yourself.'
        metadata:
          anyOf:
          - $ref: '#/components/schemas/MetadataParam'
          - type: 'null'
          description: Request metadata.
        output_config:
          anyOf:
          - $ref: '#/components/schemas/OutputConfigParam'
          - type: 'null'
          description: Configuration options for the model's output, such as the output
            format.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - standard_only
            - flex
            - priority
            - reserved
          - type: 'null'
          title: Service Tier
          description: Determines whether to use priority capacity (if available)
            or standard capacity. See service-tiers documentation for details.
        stop_sequences:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop Sequences
          description: Custom sequences that stop generation when encountered. The
            response `stop_reason` becomes `stop_sequence`. The response `stop_sequence`
            holds the matched value on models that report it, and is `null` otherwise.
        stream:
          type: boolean
          title: Stream
          description: Whether to incrementally stream the response using server-sent
            events (SSE).
          default: false
        system:
          anyOf:
          - type: string
          - items:
              $ref: '#/components/schemas/TextBlockParam'
            type: array
          - type: 'null'
          title: System
          description: System prompt providing context and instructions, such as a
            goal or role.
        temperature:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Temperature
          description: Randomness of the response, 0.0-1.0 (default 1.0). Lower values
            suit analytical/multiple-choice tasks, higher values suit creative tasks.
            Not fully deterministic even at 0.0. Accepted and ignored on some models
            with fixed sampling.
        thinking:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ThinkingConfigEnabledParam'
            - $ref: '#/components/schemas/ThinkingConfigDisabledParam'
            - $ref: '#/components/schemas/ThinkingConfigAdaptiveParam'
            - $ref: '#/components/schemas/ThinkingConfigBetweenToolsParam'
            discriminator:
              propertyName: type
              mapping:
                adaptive: '#/components/schemas/ThinkingConfigAdaptiveParam'
                between_tools: '#/components/schemas/ThinkingConfigBetweenToolsParam'
                disabled: '#/components/schemas/ThinkingConfigDisabledParam'
                enabled: '#/components/schemas/ThinkingConfigEnabledParam'
          - type: 'null'
          title: Thinking
          description: Extended thinking configuration. When enabled, responses include
            `thinking` content blocks showing the model's reasoning before the final
            answer.
        tool_choice:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ToolChoiceAutoParam'
            - $ref: '#/components/schemas/ToolChoiceAnyParam'
            - $ref: '#/components/schemas/ToolChoiceToolParam'
            - $ref: '#/components/schemas/ToolChoiceNoneParam'
            discriminator:
              propertyName: type
              mapping:
                any: '#/components/schemas/ToolChoiceAnyParam'
                auto: '#/components/schemas/ToolChoiceAutoParam'
                none: '#/components/schemas/ToolChoiceNoneParam'
                tool: '#/components/schemas/ToolChoiceToolParam'
          - type: 'null'
          title: Tool Choice
          description: 'How the model should use the provided tools: a specific tool,
            any available tool, model''s choice, or none.'
        tools:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/ToolParam'
              - $ref: '#/components/schemas/ToolBashParam'
              - $ref: '#/components/schemas/ToolTextEditorParam'
              - $ref: '#/components/schemas/ToolComputerParam'
              - $ref: '#/components/schemas/WebSearchToolParam'
              - $ref: '#/components/schemas/CodeExecutionToolParam'
              - $ref: '#/components/schemas/MemoryToolParam'
              - $ref: '#/components/schemas/WebFetchToolParam'
              - $ref: '#/components/schemas/ToolSearchToolBm25Param'
              - $ref: '#/components/schemas/ToolSearchToolRegexParam'
              - $ref: '#/components/schemas/MCPToolsetParam'
              - $ref: '#/components/schemas/BrowserToolsetParam'
              - $ref: '#/components/schemas/ComputerToolsetParam'
            type: array
          - type: 'null'
          title: Tools
          description: Tool definitions the model may use. Each includes `name`, an
            optional but recommended `description`, and `input_schema` (JSON Schema
            for the tool's `input`). The model returns `tool_use` content blocks;
            run the tool and return results via `tool_result` content blocks. Client
            tools run on your side; server tools have their own documented behavior.
        top_k:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Top K
          description: Sample only from the top K most likely tokens per step, removing
            low-probability outliers. Advanced use only; prefer `temperature`. Not
            supported by every model; where it is unsupported, pass it through the
            extra model parameters under the name that model expects.
        top_p:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Top P
          description: 'Nucleus sampling: cuts off the cumulative token probability
            distribution at `top_p`. Use either `temperature` or `top_p`, not both.
            Advanced use only; prefer `temperature`. Accepted and ignored on some
            models with fixed sampling.'
        container:
          anyOf:
          - $ref: '#/components/schemas/ContainerParams'
          - type: string
          - type: 'null'
          title: Container
          description: 'Container to reuse across requests: its identifier, or an
            object naming the identifier and the skills to load.

            UNSUPPORTED on this implementation: accepted and ignored, and the rest
            of the request is served normally. No container is created, reused or
            returned, and no skill is loaded.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - messages
      title: MessageCreateParams
      description: Create message request following the Messages API specification.
    MessageParam:
      properties:
        role:
          type: string
          enum:
          - user
          - assistant
          - system
          title: Role
          description: Message role.
        content:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/TextBlockParam'
              - $ref: '#/components/schemas/ImageBlockParam'
              - $ref: '#/components/schemas/DocumentBlockParam'
              - $ref: '#/components/schemas/SearchResultBlockParam'
              - $ref: '#/components/schemas/ThinkingBlockParam'
              - $ref: '#/components/schemas/RedactedThinkingBlockParam'
              - $ref: '#/components/schemas/ToolUseBlockParam'
              - $ref: '#/components/schemas/ToolResultBlockParam'
              - $ref: '#/components/schemas/ServerToolUseBlockParam'
              - $ref: '#/components/schemas/WebSearchToolResultBlockParam'
              - $ref: '#/components/schemas/WebFetchToolResultBlockParam'
              - $ref: '#/components/schemas/CodeExecutionToolResultBlockParam'
              - $ref: '#/components/schemas/BashCodeExecutionToolResultBlockParam'
              - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlockParam'
              - $ref: '#/components/schemas/ToolSearchToolResultBlockParam'
              - $ref: '#/components/schemas/ContainerUploadBlockParam'
              - oneOf:
                - $ref: '#/components/schemas/TextBlock'
                - $ref: '#/components/schemas/ThinkingBlock'
                - $ref: '#/components/schemas/RedactedThinkingBlock'
                - $ref: '#/components/schemas/ToolUseBlock'
                - $ref: '#/components/schemas/ServerToolUseBlock'
                - $ref: '#/components/schemas/WebSearchToolResultBlock'
                - $ref: '#/components/schemas/WebFetchToolResultBlock'
                - $ref: '#/components/schemas/CodeExecutionToolResultBlock'
                - $ref: '#/components/schemas/BashCodeExecutionToolResultBlock'
                - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlock'
                - $ref: '#/components/schemas/ToolSearchToolResultBlock'
                - $ref: '#/components/schemas/ContainerUploadBlock'
                discriminator:
                  propertyName: type
                  mapping:
                    bash_code_execution_tool_result: '#/components/schemas/BashCodeExecutionToolResultBlock'
                    code_execution_tool_result: '#/components/schemas/CodeExecutionToolResultBlock'
                    container_upload: '#/components/schemas/ContainerUploadBlock'
                    redacted_thinking: '#/components/schemas/RedactedThinkingBlock'
                    server_tool_use: '#/components/schemas/ServerToolUseBlock'
                    text: '#/components/schemas/TextBlock'
                    text_editor_code_execution_tool_result: '#/components/schemas/TextEditorCodeExecutionToolResultBlock'
                    thinking: '#/components/schemas/ThinkingBlock'
                    tool_search_tool_result: '#/components/schemas/ToolSearchToolResultBlock'
                    tool_use: '#/components/schemas/ToolUseBlock'
                    web_fetch_tool_result: '#/components/schemas/WebFetchToolResultBlock'
                    web_search_tool_result: '#/components/schemas/WebSearchToolResultBlock'
            type: array
          title: Content
          description: Message content.
      type: object
      required:
      - role
      - content
      title: MessageParam
      description: Base message parameter.
    MessageTokensCount:
      properties:
        input_tokens:
          type: integer
          title: Input Tokens
          description: The total number of tokens across the provided list of messages,
            system prompt, and tools.
        context_management:
          anyOf:
          - $ref: '#/components/schemas/CountTokensContextManagementResponse'
          - type: 'null'
          description: Count before context editing; present when the request sets
            `context_management` on a Claude model.
      additionalProperties: false
      type: object
      required:
      - input_tokens
      title: MessageTokensCount
      description: Token count response from the Messages API.
    MetadataParam:
      properties:
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: End-user identifier.
      type: object
      title: MetadataParam
      description: Request metadata for tracking and filtering.
    Model:
      properties:
        id:
          type: string
          minLength: 1
          title: Id
          description: The unique identifier for the model.
        object:
          type: string
          const: model
          title: Object
          description: The object type ("model").
          default: model
        created:
          type: integer
          minimum: 0.0
          title: Created
          description: The Unix timestamp when the model was created.
        owned_by:
          type: string
          minLength: 1
          title: Owned By
          description: The organization that owns the model.
      additionalProperties: false
      type: object
      required:
      - id
      - created
      - owned_by
      title: Model
      description: OpenAI-compatible Model.
    ModelDetails:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        provider:
          type: string
          title: Provider
        service:
          type: string
          title: Service
          default: AWS Bedrock Runtime
        input_modalities:
          items:
            type: string
          type: array
          title: Input Modalities
        output_modalities:
          items:
            type: string
          type: array
          title: Output Modalities
        response_streaming:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Response Streaming
        batch:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Batch
        legacy:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Legacy
        start_of_life_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Of Life Time
        end_of_life_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Of Life Time
        legacy_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Legacy Time
        public_extended_access_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Public Extended Access Time
        aliases:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Aliases
        regions:
          items:
            $ref: '#/components/schemas/RegionName'
          type: array
          title: Regions
        inference_profiles:
          anyOf:
          - additionalProperties:
              type: string
            propertyNames:
              $ref: '#/components/schemas/RegionName'
            type: object
          - type: 'null'
          title: Inference Profiles
        supported_routes:
          items:
            type: string
          type: array
          title: Supported Routes
          default: []
        supported_mcp_tools:
          items:
            type: string
          type: array
          title: Supported Mcp Tools
          default: []
      type: object
      required:
      - id
      - name
      - provider
      - input_modalities
      - output_modalities
      - regions
      title: ModelDetails
      description: "Metadata and capability flags for a single Bedrock model.\n\n\
        Attributes:\n    id: Bedrock model identifier.\n    name: Human-readable model\
        \ name.\n    provider: Model provider name (e.g. Anthropic, Amazon).\n   \
        \ service: AWS service hosting the model.\n    input_modalities: Accepted\
        \ input types (e.g. TEXT, IMAGE).\n    output_modalities: Produced output\
        \ types (e.g. TEXT, IMAGE).\n    response_streaming: Whether the model supports\
        \ streaming responses.\n    batch: Whether the model is advertised for the\
        \ Batch API (best effort;\n        omitted when unknown).\n    legacy: Whether\
        \ the model is deprecated.\n    start_of_life_time: GA date, if known.\n \
        \   end_of_life_time: Deprecation date, if known.\n    legacy_time: Date the\
        \ model was marked legacy, if known.\n    public_extended_access_time: Extended\
        \ public-access end date, if known.\n    aliases: Alternative model IDs that\
        \ resolve to this model.\n    regions: All regions where the model is accessible.\n\
        \    inference_profiles: Per-region inference profile ARNs.\n    supported_routes:\
        \ Route paths this model can serve (e.g. /v1/chat/completions).\n    supported_mcp_tools:\
        \ MCP tool names (operation_ids) this model can serve."
    ModelDetailsSummary:
      properties:
        parent_model:
          type: string
          title: Parent Model
          description: Model this one derives from.
          default: ''
        format:
          type: string
          title: Format
          description: Model file format.
          default: ''
        family:
          type: string
          title: Family
          description: Primary model family.
          default: ''
        families:
          items:
            type: string
          type: array
          title: Families
          description: Every family the model belongs to.
        parameter_size:
          type: string
          title: Parameter Size
          description: Approximate parameter count.
          default: ''
        quantization_level:
          type: string
          title: Quantization Level
          description: Quantization level.
          default: ''
      additionalProperties: false
      type: object
      title: ModelDetailsSummary
      description: 'Origin of a model''s weights.


        Describes a local model file; a hosted model has no such file, so every

        field but the family is reported empty rather than invented.'
    ModelInfo:
      properties:
        id:
          type: string
          title: Id
          description: Unique model identifier.
        created_at:
          type: string
          title: Created At
          description: RFC 3339 datetime string representing the time at which the
            model was released. May be set to an epoch value if the release date is
            unknown.
        display_name:
          type: string
          title: Display Name
          description: A human-readable name for the model.
        type:
          type: string
          const: model
          title: Type
          description: Object type. For Models, this is always `"model"`.
          default: model
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - display_name
      title: ModelInfo
      description: Model information.
    ModelListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ModelInfo'
          type: array
          title: Data
          description: List of model objects.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more results available.
          default: false
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: The ID of the first model in the list.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: The ID of the last model in the list.
      additionalProperties: false
      type: object
      required:
      - data
      title: ModelListResponse
      description: Paginated list of models.
    ModelOptions:
      properties:
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
          description: Random seed for reproducible outputs.
        temperature:
          anyOf:
          - type: number
          - type: 'null'
          title: Temperature
          description: Sampling randomness; higher is more random.
        top_k:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top K
          description: Limits next-token selection to the K most likely.
        top_p:
          anyOf:
          - type: number
          - type: 'null'
          title: Top P
          description: Nucleus sampling cumulative probability threshold.
        min_p:
          anyOf:
          - type: number
          - type: 'null'
          title: Min P
          description: Minimum probability threshold for token selection.
        stop:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop
          description: Stop sequences that halt generation.
        num_predict:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Predict
          description: Maximum number of tokens to generate.
        presence_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Presence Penalty
          description: Penalty applied to tokens already present.
        frequency_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Frequency Penalty
          description: Penalty applied in proportion to token frequency.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      title: ModelOptions
      description: 'Runtime options controlling text generation.


        Options tuning a local runner (``num_ctx``, ``num_gpu``, ``num_thread``, …)

        have no equivalent on a hosted backend and are accepted and ignored.'
    ModelPricing:
      properties:
        id:
          type: string
          title: Id
        service:
          type: string
          title: Service
        default_tier:
          type: string
          title: Default Tier
        default_routings:
          items:
            type: string
          type: array
          title: Default Routings
        prices:
          items:
            $ref: '#/components/schemas/PriceRow'
          type: array
          title: Prices
      type: object
      required:
      - id
      - service
      - default_tier
      - default_routings
      - prices
      title: ModelPricing
      description: "Published price card for one model.\n\nAttributes:\n    id: The\
        \ model ID as requested.\n    service: AWS service/API the prices apply to\
        \ (e.g. bedrock-runtime).\n    default_tier: Service tier this server applies\
        \ to the model by default.\n    default_routings: Serving profiles this server\
        \ can use for the model\n        across its configured regions (\"global\"\
        , geography prefixes, or\n        AWS regions), in configured-region order.\n\
        \    prices: Matching price rows; empty when AWS publishes none."
    ModelSummary:
      properties:
        name:
          type: string
          title: Name
          description: Model name.
        model:
          type: string
          title: Model
          description: Model name.
        modified_at:
          type: string
          title: Modified At
          description: Last modified timestamp, ISO 8601.
        size:
          type: integer
          title: Size
          description: Size on disk in bytes; always 0 for a hosted model.
          default: 0
        digest:
          type: string
          title: Digest
          description: Stable identifier derived from the model name.
        details:
          $ref: '#/components/schemas/ModelDetailsSummary'
          description: Origin of the model's weights.
      additionalProperties: false
      type: object
      required:
      - name
      - model
      - modified_at
      - digest
      - details
      title: ModelSummary
      description: One entry of the model list.
    ModelsResponse:
      properties:
        object:
          type: string
          title: Object
          default: list
        data:
          items:
            $ref: '#/components/schemas/Model'
          type: array
          title: Data
      type: object
      required:
      - data
      title: ModelsResponse
      description: Response for the /v1/models endpoint following OpenAI API specification.
    Moderation:
      properties:
        flagged:
          type: boolean
          title: Flagged
          description: Whether any policy or toxicity label flagged this input.
        categories:
          $ref: '#/components/schemas/ModerationCategories'
          description: Per-category violation flags.
        category_scores:
          $ref: '#/components/schemas/ModerationCategoryScores'
          description: Per-category scores from guardrail confidence levels or Comprehend
            label scores.
        category_applied_input_types:
          $ref: '#/components/schemas/ModerationCategoryAppliedInputTypes'
      additionalProperties: false
      type: object
      required:
      - flagged
      - categories
      - category_scores
      title: Moderation
      description: Moderation result for a single input element.
    ModerationCategories:
      properties:
        harassment:
          type: boolean
          title: Harassment
          description: Harassing content (guardrail INSULTS filter; Comprehend HARASSMENT_OR_ABUSE
            and INSULT labels).
          default: false
        harassment/threatening:
          type: boolean
          title: Harassment/Threatening
          description: Threatening harassment. Always `false` (no backend counterpart).
          default: false
        hate:
          type: boolean
          title: Hate
          description: Hateful content (guardrail HATE filter; Comprehend HATE_SPEECH
            label).
          default: false
        hate/threatening:
          type: boolean
          title: Hate/Threatening
          description: Threatening hate. Always `false` (no backend counterpart).
          default: false
        illicit:
          type: boolean
          title: Illicit
          description: Advice on wrongdoing (guardrail MISCONDUCT filter; no Comprehend
            label).
          default: false
        illicit/violent:
          type: boolean
          title: Illicit/Violent
          description: Violent wrongdoing. Always `false` (no backend counterpart).
          default: false
        self-harm:
          type: boolean
          title: Self-Harm
          description: Self-harm content. Always `false` (no backend counterpart).
          default: false
        self-harm/instructions:
          type: boolean
          title: Self-Harm/Instructions
          description: Self-harm instructions. Always `false` (no backend counterpart).
          default: false
        self-harm/intent:
          type: boolean
          title: Self-Harm/Intent
          description: Self-harm intent. Always `false` (no backend counterpart).
          default: false
        sexual:
          type: boolean
          title: Sexual
          description: Sexual content (guardrail SEXUAL filter; Comprehend SEXUAL
            label).
          default: false
        sexual/minors:
          type: boolean
          title: Sexual/Minors
          description: Sexual content involving minors. Always `false` (no backend
            counterpart).
          default: false
        violence:
          type: boolean
          title: Violence
          description: Violent content (guardrail VIOLENCE filter; Comprehend VIOLENCE_OR_THREAT
            label).
          default: false
        violence/graphic:
          type: boolean
          title: Violence/Graphic
          description: Graphic violence (Comprehend GRAPHIC label; no guardrail filter).
          default: false
      additionalProperties: false
      type: object
      title: ModerationCategories
      description: 'Per-category violation flags.


        Categories without a model counterpart (guardrail content filter or

        Comprehend toxicity label) are always ``false``; violations they would

        cover surface through the closest mapped category or the overall

        ``flagged`` field.'
    ModerationCategoryAppliedInputTypes:
      properties:
        harassment:
          items:
            type: string
            const: text
          type: array
          title: Harassment
          description: The applied input type(s) for the category 'harassment'.
        harassment/threatening:
          items:
            type: string
            const: text
          type: array
          title: Harassment/Threatening
          description: The applied input type(s) for the category 'harassment/threatening'.
        hate:
          items:
            type: string
            const: text
          type: array
          title: Hate
          description: The applied input type(s) for the category 'hate'.
        hate/threatening:
          items:
            type: string
            const: text
          type: array
          title: Hate/Threatening
          description: The applied input type(s) for the category 'hate/threatening'.
        illicit:
          items:
            type: string
            const: text
          type: array
          title: Illicit
          description: The applied input type(s) for the category 'illicit'.
        illicit/violent:
          items:
            type: string
            const: text
          type: array
          title: Illicit/Violent
          description: The applied input type(s) for the category 'illicit/violent'.
        self-harm:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Self-Harm
          description: The applied input type(s) for the category 'self-harm'.
        self-harm/instructions:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Self-Harm/Instructions
          description: The applied input type(s) for the category 'self-harm/instructions'.
        self-harm/intent:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Self-Harm/Intent
          description: The applied input type(s) for the category 'self-harm/intent'.
        sexual:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Sexual
          description: The applied input type(s) for the category 'sexual'.
        sexual/minors:
          items:
            type: string
            const: text
          type: array
          title: Sexual/Minors
          description: The applied input type(s) for the category 'sexual/minors'.
        violence:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Violence
          description: The applied input type(s) for the category 'violence'.
        violence/graphic:
          items:
            type: string
            enum:
            - text
            - image
          type: array
          title: Violence/Graphic
          description: The applied input type(s) for the category 'violence/graphic'.
      additionalProperties: false
      type: object
      title: ModerationCategoryAppliedInputTypes
      description: Per-category input type(s) that the score applies to.
    ModerationCategoryScores:
      properties:
        harassment:
          type: number
          title: Harassment
          description: Harassment score.
          default: 0.0
        harassment/threatening:
          type: number
          title: Harassment/Threatening
          description: Threatening harassment score.
          default: 0.0
        hate:
          type: number
          title: Hate
          description: Hate score.
          default: 0.0
        hate/threatening:
          type: number
          title: Hate/Threatening
          description: Threatening hate score.
          default: 0.0
        illicit:
          type: number
          title: Illicit
          description: Illicit score.
          default: 0.0
        illicit/violent:
          type: number
          title: Illicit/Violent
          description: Violent illicit score.
          default: 0.0
        self-harm:
          type: number
          title: Self-Harm
          description: Self-harm score.
          default: 0.0
        self-harm/instructions:
          type: number
          title: Self-Harm/Instructions
          description: Self-harm instructions score.
          default: 0.0
        self-harm/intent:
          type: number
          title: Self-Harm/Intent
          description: Self-harm intent score.
          default: 0.0
        sexual:
          type: number
          title: Sexual
          description: Sexual content score.
          default: 0.0
        sexual/minors:
          type: number
          title: Sexual/Minors
          description: Sexual minors score.
          default: 0.0
        violence:
          type: number
          title: Violence
          description: Violence score.
          default: 0.0
        violence/graphic:
          type: number
          title: Violence/Graphic
          description: Graphic violence score.
          default: 0.0
      additionalProperties: false
      type: object
      title: ModerationCategoryScores
      description: Per-category scores from guardrail confidence levels or Comprehend
        labels.
    ModerationCreateParams:
      properties:
        input:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
            maxItems: 2048
            minItems: 1
          - items:
              anyOf:
              - $ref: '#/components/schemas/ModerationImageURLInput'
              - $ref: '#/components/schemas/ModerationTextInput'
            type: array
            maxItems: 2048
            minItems: 1
          title: Input
          description: Text or image inputs to classify (at most 2048). Each element
            yields one result and is billed separately.
        model:
          anyOf:
          - type: string
            maxLength: 2048
            minLength: 1
          - type: 'null'
          title: Model
          description: 'The moderation model: a guardrail (`amazon.bedrock-runtime-guardrail`
            for the server''s default guardrail, or an explicit `<id>`, `<id>:<version>`,
            or ARN), or `amazon.comprehend-toxicity` for toxicity detection. Omitted
            resolves to the server''s default moderation model; OpenAI moderation
            model names are aliases (`omni-moderation-*` for the default guardrail,
            falling back to toxicity detection when none is configured; `text-moderation-*`
            for toxicity detection).'
      type: object
      required:
      - input
      title: ModerationCreateParams
      description: Request body for POST /v1/moderations.
    ModerationCreateResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the moderation request.
        model:
          type: string
          title: Model
          description: The moderation model as requested (aliases are echoed as sent).
        results:
          items:
            $ref: '#/components/schemas/Moderation'
          type: array
          title: Results
          description: One result per input element.
      additionalProperties: false
      type: object
      required:
      - id
      - model
      - results
      title: ModerationCreateResponse
      description: Response body for POST /v1/moderations.
    ModerationImageURL:
      properties:
        url:
          type: string
          minLength: 1
          title: Url
          description: Image as an HTTPS URL, data URI, base64 string, or S3 URI.
      type: object
      required:
      - url
      title: ModerationImageURL
      description: Image container for an image moderation input.
    ModerationImageURLInput:
      properties:
        type:
          type: string
          const: image_url
          title: Type
          description: Input type. Always `image_url`.
        image_url:
          $ref: '#/components/schemas/ModerationImageURL'
          description: The image to classify.
      type: object
      required:
      - type
      - image_url
      title: ModerationImageURLInput
      description: An image input to a moderation request.
    ModerationResult:
      properties:
        type:
          type: string
          const: moderation_result
          title: Type
          description: The object type, which is always `moderation_result`.
          default: moderation_result
        flagged:
          type: boolean
          title: Flagged
          description: Whether the guardrail flagged the content.
        categories:
          additionalProperties:
            type: boolean
          type: object
          title: Categories
          description: Per-category violation flags (OpenAI moderation categories).
        category_scores:
          additionalProperties:
            type: number
          type: object
          title: Category Scores
          description: Per-category scores derived from guardrail confidence levels.
        category_applied_input_types:
          additionalProperties:
            items:
              type: string
              enum:
              - text
              - image
            type: array
          type: object
          title: Category Applied Input Types
          description: Which modalities of input are reflected by the score for each
            category.
        model:
          type: string
          title: Model
          description: The guardrail that classified the content.
      additionalProperties: false
      type: object
      required:
      - flagged
      - categories
      - category_scores
      - category_applied_input_types
      - model
      title: ModerationResult
      description: Moderation outcome for one direction of a generation.
    ModerationTextInput:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Input type. Always `text`.
        text:
          type: string
          title: Text
          description: The text to classify.
      type: object
      required:
      - type
      - text
      title: ModerationTextInput
      description: A text input to a moderation request.
    ModerationsResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.moderations.result
          title: Object
          default: organization.usage.moderations.result
        input_tokens:
          type: integer
          title: Input Tokens
          description: Input tokens.
          default: 0
      additionalProperties: false
      type: object
      title: ModerationsResult
      description: Aggregated moderations usage of one time bucket.
    MoonshotThinkingOptions:
      properties:
        type:
          type: string
          enum:
          - enabled
          - disabled
          title: Type
          description: Enable or disable thinking capability.
      type: object
      required:
      - type
      title: MoonshotThinkingOptions
      description: 'Thinking configuration for Moonshot models.


        Controls whether thinking is enabled for the model.'
    NamespaceTool:
      properties:
        description:
          type: string
          title: Description
          description: Description shown to the model.
        name:
          type: string
          title: Name
          description: Namespace name.
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/NamespaceToolFunction'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
            discriminator:
              propertyName: type
              mapping:
                custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                function: '#/components/schemas/NamespaceToolFunction'
          type: array
          title: Tools
          description: Tools available in this namespace.
        type:
          type: string
          const: namespace
          title: Type
          description: Namespace tool type.
      type: object
      required:
      - description
      - name
      - tools
      - type
      title: NamespaceTool
      description: 'Groups function/custom tools under a shared namespace.


        UNSUPPORTED on this implementation.'
    NamespaceToolFunction:
      properties:
        name:
          type: string
          title: Name
          description: Function name.
        type:
          type: string
          const: function
          title: Type
          description: Function type.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Deferred and discovered via tool search.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Function description.
        parameters:
          anyOf:
          - {}
          - type: 'null'
          title: Parameters
          description: Parameter schema.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enforce strict validation.
      type: object
      required:
      - name
      - type
      title: NamespaceToolFunction
      description: A function tool within a namespace.
    NoiseReduction:
      properties:
        type:
          anyOf:
          - type: string
            enum:
            - near_field
            - far_field
          - type: 'null'
          title: Type
          description: 'UNSUPPORTED: incoming audio is not filtered.'
      type: object
      title: NoiseReduction
      description: Noise reduction applied to the incoming audio.
    OutputConfigParam:
      properties:
        effort:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Effort
          description: Effort level for the model's output processing.
        format:
          anyOf:
          - $ref: '#/components/schemas/JSONOutputFormatParam'
          - type: 'null'
          description: A schema to specify output format in responses. See structured
            outputs documentation.
      type: object
      title: OutputConfigParam
      description: Configuration options for the model's output.
    PendingSafetyCheck:
      properties:
        id:
          type: string
          title: Id
          description: Safety check ID.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Safety check type.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Safety check details.
      additionalProperties: false
      type: object
      required:
      - id
      title: PendingSafetyCheck
      description: A pending safety check for the computer call.
    PlainTextSource:
      properties:
        data:
          type: string
          title: Data
          description: The data content.
        media_type:
          type: string
          const: text/plain
          title: Media Type
          description: The media type.
        type:
          type: string
          const: text
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - data
      - media_type
      - type
      title: PlainTextSource
      description: Plain text source.
    PlainTextSourceParam:
      properties:
        data:
          type: string
          title: Data
          description: Data content.
        media_type:
          type: string
          const: text/plain
          title: Media Type
          description: Media type.
        type:
          type: string
          const: text
          title: Type
          description: Type discriminator.
      type: object
      required:
      - data
      - media_type
      - type
      title: PlainTextSourceParam
      description: Plain text source for document content block.
    PriceRow:
      properties:
        region:
          type: string
          title: Region
        dimension:
          $ref: '#/components/schemas/Dimension'
        tier:
          type: string
          title: Tier
        cache_ttl:
          anyOf:
          - type: string
          - type: 'null'
          title: Cache Ttl
        routing:
          type: string
          title: Routing
        spec:
          anyOf:
          - type: string
          - type: 'null'
          title: Spec
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
        unit_price:
          type: string
          title: Unit Price
        currency:
          type: string
          title: Currency
      type: object
      required:
      - region
      - dimension
      - tier
      - routing
      - unit_price
      - currency
      title: PriceRow
      description: "One published unit price for a model.\n\nAttributes:\n    region:\
        \ AWS region the price applies to.\n    dimension: Billed dimension (same\
        \ vocabulary as request-log usage).\n    tier: Service tier (standard, flex,\
        \ priority, batch).\n    cache_ttl: Prompt-cache write TTL bucket, when distinctly\
        \ priced.\n    routing: Serving profile: \"global\" (global cross-region inference),\
        \ a\n        geography prefix like \"eu\"/\"us\" (regional cross-region inference),\n\
        \        an AWS region (single-region inference), or \"latency\" for the\n\
        \        latency-optimized price variant.\n    spec: Media bucket (e.g. image\
        \ \"resolution:quality\"), when applicable.\n    context: \"long\" for the\
        \ prompt rate past the model's own short-context\n        boundary, 200K tokens\
        \ for most and 272K for some families.\n    unit_price: Exact plain-decimal\
        \ price per ONE billed unit.\n    currency: ISO currency code of the price."
    Program:
      properties:
        id:
          type: string
          title: Id
          description: Program ID.
        call_id:
          type: string
          title: Call Id
          description: Identifier mapping this program to its output.
        code:
          type: string
          title: Code
          description: Code executed by the program.
        fingerprint:
          type: string
          title: Fingerprint
          description: Program fingerprint.
        type:
          type: string
          const: program
          title: Type
          description: Item type. Always `program`.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - code
      - fingerprint
      - type
      title: Program
      description: A program emitted by programmatic tool calling.
    ProgramInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the program.
        call_id:
          type: string
          title: Call Id
          description: An identifier used to map this program to its output.
        code:
          type: string
          title: Code
          description: The code executed by the program.
        fingerprint:
          type: string
          title: Fingerprint
          description: The fingerprint of the program.
        type:
          type: string
          const: program
          title: Type
          description: The type of the item. Always `program`.
      type: object
      required:
      - id
      - call_id
      - code
      - fingerprint
      - type
      title: ProgramInput
      description: A program emitted by programmatic tool calling (as input item).
    ProgramOutput:
      properties:
        id:
          type: string
          title: Id
          description: Program output ID.
        call_id:
          type: string
          title: Call Id
          description: Identifier mapping this output to its program.
        result:
          type: string
          title: Result
          description: Result of the program execution.
        status:
          type: string
          enum:
          - completed
          - incomplete
          title: Status
          description: Status of the program execution.
        type:
          type: string
          const: program_output
          title: Type
          description: Item type. Always `program_output`.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - result
      - status
      - type
      title: ProgramOutput
      description: The result of a program execution.
    ProgramOutputInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the program output.
        call_id:
          type: string
          title: Call Id
          description: The call ID, used to map this output to its program.
        result:
          type: string
          title: Result
          description: The result of the program execution.
        status:
          type: string
          enum:
          - completed
          - incomplete
          title: Status
          description: The status of the program execution.
        type:
          type: string
          const: program_output
          title: Type
          description: The type of the item. Always `program_output`.
      type: object
      required:
      - id
      - call_id
      - result
      - status
      - type
      title: ProgramOutputInput
      description: The result of a program execution (as input item).
    ProgrammaticToolCalling:
      properties:
        type:
          type: string
          const: programmatic_tool_calling
          title: Type
          description: Programmatic tool calling type.
      type: object
      required:
      - type
      title: ProgrammaticToolCalling
      description: 'Lets the model call other tools from generated code.


        Honored only by models that support programmatic tool calling;

        accepted and ignored on all others.'
    PromptCacheBreakpoint-Output:
      properties:
        mode:
          type: string
          const: explicit
          title: Mode
          description: 'Breakpoint mode. Always `explicit`: the prompt prefix ending
            with this content part is cached.'
          default: explicit
      type: object
      title: PromptCacheBreakpoint
      description: Explicit prompt-cache breakpoint set on an input content part.
    PromptCacheOptions-Output:
      properties:
        mode:
          anyOf:
          - type: string
            enum:
            - implicit
            - explicit
          - type: 'null'
          title: Mode
          description: 'Caching mode. `explicit`: only content parts marked with `prompt_cache_breakpoint`
            are cached. `implicit` (default): sections selected with `prompt_cache_key`
            are cached too.'
        ttl:
          anyOf:
          - type: string
            const: 30m
          - type: 'null'
          title: Ttl
          description: 'Cache retention: `30m` is applied as 1h. Ignored when `prompt_cache_retention`
            is set.'
      type: object
      title: PromptCacheOptions
      description: Explicit prompt-caching configuration for a request.
    PromptTokensDetails:
      properties:
        audio_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Audio Tokens
          description: Audio input tokens present in the prompt.
        cached_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cached Tokens
          description: Cached tokens present in the prompt.
        cache_write_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cache Write Tokens
          description: 'Extra feature: Tokens written to the prompt cache (reported
            by some models).'
      additionalProperties: false
      type: object
      title: PromptTokensDetails
      description: Breakdown of tokens used in the prompt.
    PsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/JsonValue'
          type: array
          title: Models
          description: Models currently loaded in memory.
      additionalProperties: false
      type: object
      title: PsResponse
      description: Running model list response.
    PullRequest:
      properties:
        model:
          type: string
          title: Model
          description: Name of the model to make available.
        insecure:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Insecure
          description: UNSUPPORTED, accepted and ignored.
        stream:
          type: boolean
          title: Stream
          description: Stream progress updates.
          default: true
      type: object
      required:
      - model
      title: PullRequest
      description: Make a model available request.
    PushRequest:
      properties:
        model:
          type: string
          title: Model
          description: Name of the model to publish.
        insecure:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Insecure
          description: UNSUPPORTED.
        stream:
          type: boolean
          title: Stream
          description: Stream progress updates.
          default: true
      type: object
      required:
      - model
      title: PushRequest
      description: Publish a model request.
    QwenTranslationMemory:
      properties:
        source:
          type: string
          title: Source
          description: Source statement
        target:
          type: string
          title: Target
          description: Target translation statement
      type: object
      required:
      - source
      - target
      title: QwenTranslationMemory
      description: 'Translation memory entry for Qwen translation.


        Provides example translations to guide the model.'
    QwenTranslationOptions:
      properties:
        source_lang:
          type: string
          title: Source Lang
          description: Source language name in English, or "auto" for auto-detection.
        target_lang:
          type: string
          title: Target Lang
          description: Target language name in English.
        terms:
          anyOf:
          - items:
              $ref: '#/components/schemas/QwenTranslationTerm'
            type: array
          - type: 'null'
          title: Terms
          description: Custom term translations with source and target.
        tm_list:
          anyOf:
          - items:
              $ref: '#/components/schemas/QwenTranslationMemory'
            type: array
          - type: 'null'
          title: Tm List
          description: Translation memory with source and target statements.
        domains:
          anyOf:
          - type: string
          - type: 'null'
          title: Domains
          description: Domain hint in English (e.g., "medical", "legal", "technical").
      type: object
      required:
      - source_lang
      - target_lang
      title: QwenTranslationOptions
      description: 'Translation options for Qwen models with translation capabilities.


        Configures source/target languages, custom term translations, translation

        memory, and domain hints for specialized translation tasks.'
    QwenTranslationTerm:
      properties:
        source:
          type: string
          title: Source
          description: Source term to translate
        target:
          type: string
          title: Target
          description: Target translation for the term
      type: object
      required:
      - source
      - target
      title: QwenTranslationTerm
      description: 'Term intervention for Qwen translation.


        Allows specifying custom translations for specific terms.'
    RankingOptions:
      properties:
        ranker:
          anyOf:
          - type: string
          - type: 'null'
          title: Ranker
          description: Reserved for a re-ranking model. Results are always ranked
            by semantic similarity, so this value does not change the ranking.
        score_threshold:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Score Threshold
          description: Drop results scoring below this value. Rejected by a vector
            store whose scores are not comparable between searches; use `max_num_results`
            there.
      type: object
      title: RankingOptions
      description: Result ranking options.
    RealtimeSessionConfig:
      properties:
        type:
          type: string
          const: realtime
          title: Type
          description: Kind of session to open.
          default: realtime
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Model serving the session.
        audio:
          $ref: '#/components/schemas/AudioConfig'
          description: Input and output audio settings.
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
          description: System instructions guiding every answer.
        output_modalities:
          anyOf:
          - items:
              type: string
              enum:
              - text
              - audio
            type: array
          - type: 'null'
          title: Output Modalities
          description: Modalities the model answers with; 'text' suppresses speech.
        max_output_tokens:
          anyOf:
          - type: integer
          - type: string
            const: inf
          - type: 'null'
          title: Max Output Tokens
          description: Cap on the tokens one answer may use.
        include:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Include
          description: 'UNSUPPORTED: no extra output fields are available.'
        tools:
          anyOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/stdapi__types__openai_realtime__FunctionTool'
              - $ref: '#/components/schemas/McpServerTool'
            type: array
          - type: 'null'
          title: Tools
          description: Functions the model may call, declared before the conversation
            opens and fixed for the rest of it; remote MCP servers are refused.
        tool_choice:
          anyOf:
          - type: string
            enum:
            - auto
            - none
            - required
          - $ref: '#/components/schemas/FunctionToolChoice'
          - $ref: '#/components/schemas/McpToolChoice'
          - type: 'null'
          title: Tool Choice
          description: 'How the model picks among the tools: ''none'' declares none
            at all, ''required'' and a named function make every answer start with
            a call. Naming a remote MCP server''s tool is accepted and ignored.'
        parallel_tool_calls:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Parallel Tool Calls
          description: 'UNSUPPORTED: how many tools one answer calls is the model''s
            own decision.'
        prompt:
          $ref: '#/components/schemas/JsonValue'
          description: 'UNSUPPORTED: prompt templates are not available.'
        reasoning:
          $ref: '#/components/schemas/JsonValue'
          description: 'UNSUPPORTED: the session reports no reasoning.'
        tracing:
          $ref: '#/components/schemas/JsonValue'
          description: 'UNSUPPORTED: session traces are not published.'
        truncation:
          $ref: '#/components/schemas/JsonValue'
          description: 'UNSUPPORTED: the conversation is not truncated server-side.'
      type: object
      title: RealtimeSessionConfig
      description: Configuration of a speech-to-speech Realtime session.
    Reasoning:
      properties:
        effort:
          anyOf:
          - type: string
            enum:
            - none
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Effort
          description: 'Reasoning effort: `none`, `minimal`, `low`, `medium`, `high`,
            `xhigh`, or `max`.'
        generate_summary:
          anyOf:
          - type: string
            enum:
            - auto
            - concise
            - detailed
          - type: 'null'
          title: Generate Summary
          description: 'Deprecated: use `summary` instead.'
        summary:
          anyOf:
          - type: string
            enum:
            - auto
            - concise
            - detailed
          - type: 'null'
          title: Summary
          description: 'Reasoning summary: `auto`, `concise`, or `detailed`.'
        context:
          anyOf:
          - type: string
            enum:
            - auto
            - current_turn
            - all_turns
          - type: 'null'
          title: Context
          description: Reasoning context scope. Honored only by models that support
            it; ignored otherwise.
        mode:
          anyOf:
          - type: string
          - type: 'null'
          title: Mode
          description: Reasoning mode, such as `standard` or `pro`. Honored only by
            models that support it; ignored otherwise.
      type: object
      title: Reasoning
      description: Configuration options for reasoning models.
    ReasoningItemContent:
      properties:
        text:
          type: string
          title: Text
          description: Reasoning text.
        type:
          type: string
          const: reasoning_text
          title: Type
          description: Reasoning text type.
      additionalProperties: false
      type: object
      required:
      - text
      - type
      title: ReasoningItemContent
      description: Reasoning text from the model.
    ReasoningItemContentInput:
      properties:
        text:
          type: string
          title: Text
          description: Reasoning text.
        type:
          type: string
          title: Type
          description: Reasoning text type, such as `reasoning_text`.
      type: object
      required:
      - text
      - type
      title: ReasoningItemContentInput
      description: 'Echoed reasoning text, tolerating any part type the client replays.


        A reasoning item arrives here only because the client is handing back an item

        it was given, so the part type carries no instruction to act on: only the
        text

        is read. Clients differ on what they put there -- ``reasoning_text``,

        ``summary_text``, and Codex''s legacy ``text`` are all seen in the wild, and

        Codex replays a reasoning item as the *first* input item of the following

        turn. Rejecting an unrecognised value fails the whole turn over an echo, so

        the type is accepted as-is and ignored.'
    ReasoningItemSummary:
      properties:
        text:
          type: string
          title: Text
          description: Reasoning summary.
        type:
          type: string
          const: summary_text
          title: Type
          description: Summary text type.
      additionalProperties: false
      type: object
      required:
      - text
      - type
      title: ReasoningItemSummary
      description: A summary text from the model.
    ReasoningOptions:
      properties:
        effort:
          anyOf:
          - type: string
            enum:
            - none
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Effort
          description: Reasoning effort, as `reasoning_effort`. Mutually exclusive
            with `max_tokens`.
        max_tokens:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Max Tokens
          description: Max reasoning length in tokens, as `thinking_budget`. Mutually
            exclusive with `effort`.
        exclude:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Exclude
          description: Omit the reasoning text from the response; it is still generated
            and billed.
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          description: Enable reasoning, as `enable_thinking`.
      type: object
      title: ReasoningOptions
      description: 'Reasoning configuration accepted as a single object.


        Groups the reasoning knobs the flat fields expose individually: `effort`

        matches `reasoning_effort`, `max_tokens` matches `thinking_budget`, and

        `enabled` matches `enable_thinking`.'
    RedactedThinkingBlock:
      properties:
        type:
          type: string
          const: redacted_thinking
          title: Type
          description: Content block type. Always `redacted_thinking`.
        data:
          type: string
          title: Data
          description: The redacted thinking content as a base64-encoded string.
      additionalProperties: false
      type: object
      required:
      - type
      - data
      title: RedactedThinkingBlock
      description: Redacted thinking content block.
    RedactedThinkingBlockParam:
      properties:
        type:
          type: string
          const: redacted_thinking
          title: Type
          description: Content block type. Always `redacted_thinking`.
        data:
          type: string
          title: Data
          description: The redacted thinking content as a base64-encoded string.
      type: object
      required:
      - type
      - data
      title: RedactedThinkingBlockParam
      description: Redacted thinking content block parameter.
    RefusalStopDetails:
      properties:
        type:
          type: string
          const: refusal
          title: Type
          description: Stop details type. Always `refusal`.
        category:
          anyOf:
          - type: string
            enum:
            - cyber
            - bio
            - frontier_llm
            - reasoning_extraction
            - general_harms
          - type: 'null'
          title: Category
          description: 'Policy category that triggered the refusal: `cyber` (could
            enable cyber harm), `bio` (could enable biological harm), `frontier_llm`
            (could assist competing model development), `reasoning_extraction` (asks
            the model to reproduce its internal reasoning) or `general_harms`. Benign
            work can also trigger a category.'
        explanation:
          anyOf:
          - type: string
          - type: 'null'
          title: Explanation
          description: Human-readable explanation of the refusal, or null when none
            is available. The wording is not guaranteed to be stable.
      additionalProperties: false
      type: object
      required:
      - type
      title: RefusalStopDetails
      description: Structured information about a refusal.
    RegionName:
      type: string
    RequestModeration:
      properties:
        model:
          type: string
          maxLength: 2048
          minLength: 1
          title: Model
          description: AWS Bedrock guardrail (`amazon.bedrock-runtime-guardrail` or
            `omni-moderation-*` for the server's default guardrail, or an explicit
            `<id>`, `<id>:<version>`, or ARN). Amazon Comprehend moderation (`amazon.comprehend-toxicity`,
            `text-moderation-*`) is not supported here.
      type: object
      required:
      - model
      title: RequestModeration
      description: Moderation configuration applied to a generation request.
    RequestToolCall:
      properties:
        function:
          $ref: '#/components/schemas/RequestToolCallFunction'
          description: Function call details.
      type: object
      required:
      - function
      title: RequestToolCall
      description: Tool call replayed in an assistant message.
    RequestToolCallFunction:
      properties:
        name:
          type: string
          title: Name
          description: Name of the function that was called.
        arguments:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Arguments
          description: JSON object of arguments passed.
        index:
          anyOf:
          - type: integer
          - type: 'null'
          title: Index
          description: Position of the call in the tool call list.
      type: object
      required:
      - name
      title: RequestToolCallFunction
      description: Function of a tool call replayed in the conversation.
    RerankRequest:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        query:
          type: string
          minLength: 1
          title: Query
          description: The search query.
        documents:
          items:
            type: string
          type: array
          minItems: 1
          title: Documents
          description: A list of texts that will be compared to the query.
        top_n:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Top N
          description: Limits the number of returned rerank results. When unset, all
            rerank results are returned.
        max_tokens_per_doc:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Tokens Per Doc
          description: Truncate long documents to this number of tokens. Supported
            by some models only.
        priority:
          anyOf:
          - type: integer
          - type: 'null'
          title: Priority
          description: Accepted for compatibility and ignored. Cohere API request
            scheduling priority is not applicable on this implementation.
        return_documents:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Return Documents
          description: 'Accepted for compatibility with the v1 API and ignored: v2
            results always reference the input documents by `index` only.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - query
      - documents
      title: RerankRequest
      description: Request body for reranking documents against a query.
    RerankResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the request.
        results:
          items:
            $ref: '#/components/schemas/RerankResult'
          type: array
          title: Results
          description: Documents ordered by decreasing relevance to the query.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      additionalProperties: false
      type: object
      required:
      - id
      - results
      - meta
      title: RerankResponse
      description: Rerank response model.
    RerankResult:
      properties:
        index:
          type: integer
          title: Index
          description: Index of the document in the request's `documents` list.
        relevance_score:
          type: number
          title: Relevance Score
          description: Relevance score of the document for the query, in [0, 1].
      additionalProperties: false
      type: object
      required:
      - index
      - relevance_score
      title: RerankResult
      description: A single reranked document reference.
    RerankV1Request:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        query:
          type: string
          minLength: 1
          title: Query
          description: The search query.
        documents:
          items:
            anyOf:
            - type: string
            - additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
          type: array
          minItems: 1
          title: Documents
          description: A list of texts, or field->value objects, that will be compared
            to the query. `rank_fields` selects which object fields are ranked on.
        top_n:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Top N
          description: Limits the number of returned rerank results. When unset, all
            rerank results are returned.
        rank_fields:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Rank Fields
          description: Object document fields to rank on. When unset, object documents
            are ranked on all of their fields.
        return_documents:
          type: boolean
          title: Return Documents
          description: When true, each result echoes back the text of the corresponding
            input document.
          default: false
        max_chunks_per_doc:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Chunks Per Doc
          description: Maximum number of chunks to produce per document. Not supported
            on this implementation.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - query
      - documents
      title: RerankV1Request
      description: Request body for reranking documents against a query (Cohere v1
        Rerank API).
    RerankV1Response:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the request.
        results:
          items:
            $ref: '#/components/schemas/RerankV1Result'
          type: array
          title: Results
          description: Documents ordered by decreasing relevance to the query.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      additionalProperties: false
      type: object
      required:
      - id
      - results
      - meta
      title: RerankV1Response
      description: Rerank response model (v1 format).
    RerankV1Result:
      properties:
        document:
          anyOf:
          - $ref: '#/components/schemas/RerankV1ResultDocument'
          - type: 'null'
          description: The input document, echoed back when `return_documents` is
            true.
        index:
          type: integer
          title: Index
          description: Index of the document in the request's `documents` list.
        relevance_score:
          type: number
          title: Relevance Score
          description: Relevance score of the document for the query, in [0, 1].
      additionalProperties: false
      type: object
      required:
      - index
      - relevance_score
      title: RerankV1Result
      description: A single reranked document reference (v1 format).
    RerankV1ResultDocument:
      properties:
        text:
          type: string
          title: Text
          description: The text of the reranked document.
      additionalProperties: false
      type: object
      required:
      - text
      title: RerankV1ResultDocument
      description: Echoed input document of a v1 rerank result.
    Response:
      properties:
        id:
          type: string
          title: Id
          description: Response ID.
        created_at:
          anyOf:
          - type: integer
          - type: number
          title: Created At
          description: Unix timestamp of creation.
        error:
          anyOf:
          - $ref: '#/components/schemas/ResponseError'
          - type: 'null'
          description: Response error if failed.
        incomplete_details:
          anyOf:
          - $ref: '#/components/schemas/IncompleteDetails'
          - type: 'null'
          description: Incomplete details.
        moderation:
          anyOf:
          - $ref: '#/components/schemas/ResponseModeration'
          - type: 'null'
          description: Guardrail moderation results, when the request set `moderation`
            (in streaming mode, carried by the terminal event).
        instructions:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Output'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Output'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Instructions
          description: System or developer message.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Key-value pairs for the response.
        model:
          type: string
          title: Model
          description: Model ID.
        object:
          type: string
          const: response
          title: Object
          description: Object type.
        output:
          items:
            oneOf:
            - $ref: '#/components/schemas/ResponseOutputMessage'
            - $ref: '#/components/schemas/ResponseFileSearchToolCall'
            - $ref: '#/components/schemas/ResponseFunctionToolCall'
            - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseFunctionWebSearch'
            - $ref: '#/components/schemas/ResponseComputerToolCall'
            - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseReasoningItem'
            - $ref: '#/components/schemas/ResponseToolSearchCall'
            - $ref: '#/components/schemas/ResponseToolSearchOutputItem'
            - $ref: '#/components/schemas/ResponseCompactionItem'
            - $ref: '#/components/schemas/ImageGenerationCall'
            - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall'
            - $ref: '#/components/schemas/LocalShellCall'
            - $ref: '#/components/schemas/LocalShellCallOutput'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCall'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCall'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput'
            - $ref: '#/components/schemas/McpCall'
            - $ref: '#/components/schemas/McpListTools'
            - $ref: '#/components/schemas/McpApprovalRequest'
            - $ref: '#/components/schemas/McpApprovalResponseOutput'
            - $ref: '#/components/schemas/ResponseCustomToolCall'
            - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem'
            - $ref: '#/components/schemas/AdditionalTools'
            - $ref: '#/components/schemas/Program'
            - $ref: '#/components/schemas/ProgramOutput'
            discriminator:
              propertyName: type
              mapping:
                additional_tools: '#/components/schemas/AdditionalTools'
                apply_patch_call: '#/components/schemas/ResponseApplyPatchToolCall'
                apply_patch_call_output: '#/components/schemas/ResponseApplyPatchToolCallOutput'
                code_interpreter_call: '#/components/schemas/ResponseCodeInterpreterToolCall'
                compaction: '#/components/schemas/ResponseCompactionItem'
                computer_call: '#/components/schemas/ResponseComputerToolCall'
                computer_call_output: '#/components/schemas/ResponseComputerToolCallOutputItem'
                custom_tool_call: '#/components/schemas/ResponseCustomToolCall'
                custom_tool_call_output: '#/components/schemas/ResponseCustomToolCallOutputItem'
                file_search_call: '#/components/schemas/ResponseFileSearchToolCall'
                function_call: '#/components/schemas/ResponseFunctionToolCall'
                function_call_output: '#/components/schemas/ResponseFunctionToolCallOutputItem'
                image_generation_call: '#/components/schemas/ImageGenerationCall'
                local_shell_call: '#/components/schemas/LocalShellCall'
                local_shell_call_output: '#/components/schemas/LocalShellCallOutput'
                mcp_approval_request: '#/components/schemas/McpApprovalRequest'
                mcp_approval_response: '#/components/schemas/McpApprovalResponseOutput'
                mcp_call: '#/components/schemas/McpCall'
                mcp_list_tools: '#/components/schemas/McpListTools'
                message: '#/components/schemas/ResponseOutputMessage'
                program: '#/components/schemas/Program'
                program_output: '#/components/schemas/ProgramOutput'
                reasoning: '#/components/schemas/ResponseReasoningItem'
                shell_call: '#/components/schemas/ResponseFunctionShellToolCall'
                shell_call_output: '#/components/schemas/ResponseFunctionShellToolCallOutput'
                tool_search_call: '#/components/schemas/ResponseToolSearchCall'
                tool_search_output: '#/components/schemas/ResponseToolSearchOutputItem'
                web_search_call: '#/components/schemas/ResponseFunctionWebSearch'
          type: array
          title: Output
          description: Generated content items.
        parallel_tool_calls:
          type: boolean
          title: Parallel Tool Calls
          description: Allow parallel tool calls.
        temperature:
          anyOf:
          - type: number
          - type: 'null'
          title: Temperature
          description: Sampling temperature (0-2).
        tool_choice:
          anyOf:
          - type: string
            enum:
            - none
            - auto
            - required
          - $ref: '#/components/schemas/ToolChoiceAllowed'
          - $ref: '#/components/schemas/ToolChoiceTypes'
          - $ref: '#/components/schemas/ToolChoiceFunction'
          - $ref: '#/components/schemas/ToolChoiceMcp'
          - $ref: '#/components/schemas/ToolChoiceCustom'
          - $ref: '#/components/schemas/ToolChoiceApplyPatch'
          - $ref: '#/components/schemas/ToolChoiceShell'
          - $ref: '#/components/schemas/ToolChoiceProgrammaticToolCalling'
          title: Tool Choice
          description: Tool selection method.
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
            - $ref: '#/components/schemas/FileSearchTool'
            - $ref: '#/components/schemas/ComputerTool'
            - $ref: '#/components/schemas/ComputerUsePreviewTool'
            - $ref: '#/components/schemas/WebSearchTool'
            - $ref: '#/components/schemas/Mcp'
            - $ref: '#/components/schemas/CodeInterpreter'
            - $ref: '#/components/schemas/ImageGeneration'
            - $ref: '#/components/schemas/LocalShell'
            - $ref: '#/components/schemas/FunctionShellTool'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
            - $ref: '#/components/schemas/NamespaceTool'
            - $ref: '#/components/schemas/ToolSearchTool'
            - $ref: '#/components/schemas/WebSearchPreviewTool'
            - $ref: '#/components/schemas/ApplyPatchTool'
            - $ref: '#/components/schemas/ProgrammaticToolCalling'
            discriminator:
              propertyName: type
              mapping:
                apply_patch: '#/components/schemas/ApplyPatchTool'
                code_interpreter: '#/components/schemas/CodeInterpreter'
                computer: '#/components/schemas/ComputerTool'
                computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                file_search: '#/components/schemas/FileSearchTool'
                function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                image_generation: '#/components/schemas/ImageGeneration'
                local_shell: '#/components/schemas/LocalShell'
                mcp: '#/components/schemas/Mcp'
                namespace: '#/components/schemas/NamespaceTool'
                programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                shell: '#/components/schemas/FunctionShellTool'
                tool_search: '#/components/schemas/ToolSearchTool'
                web_search: '#/components/schemas/WebSearchTool'
                web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
          type: array
          title: Tools
          description: Available tools.
        top_p:
          anyOf:
          - type: number
          - type: 'null'
          title: Top P
          description: Nucleus sampling parameter.
        background:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Background
          description: Run in background.
        completed_at:
          anyOf:
          - type: integer
          - type: number
          - type: 'null'
          title: Completed At
          description: Completion timestamp.
        conversation:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_responses__Conversation'
          - type: 'null'
          description: Conversation.
        max_output_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Output Tokens
          description: Max output tokens.
        max_tool_calls:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Tool Calls
          description: Max tool calls allowed.
        previous_response_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Response Id
          description: Previous response ID for multi-turn.
        prompt:
          anyOf:
          - $ref: '#/components/schemas/ResponsePrompt'
          - type: 'null'
          description: Prompt template reference.
        prompt_cache_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Cache Key
          description: Cache key for similar requests.
        prompt_cache_options:
          anyOf:
          - $ref: '#/components/schemas/PromptCacheOptions-Output'
          - type: 'null'
          description: Explicit prompt-caching configuration, echoed from the request.
        prompt_cache_retention:
          anyOf:
          - type: string
            enum:
            - in_memory
            - 24h
            - 1h
            - 5m
          - type: 'null'
          title: Prompt Cache Retention
          description: Cache retention policy.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/Reasoning'
          - type: 'null'
          description: Reasoning configuration.
        safety_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Safety Identifier
          description: User policy violation identifier.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - ultrafast
          - type: 'null'
          title: Service Tier
          description: 'Processing tier the request asked for, after alias mapping:
            `fast` is reported as `priority`, and a tier with no equivalent as `default`.'
        status:
          anyOf:
          - type: string
            enum:
            - completed
            - failed
            - in_progress
            - cancelled
            - queued
            - incomplete
          - type: 'null'
          title: Status
          description: Response status.
        text:
          anyOf:
          - $ref: '#/components/schemas/ResponseTextConfig'
          - type: 'null'
          description: Text response config.
        top_logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Top Logprobs
          description: Top logprobs count (0-20).
        truncation:
          anyOf:
          - type: string
            enum:
            - auto
            - disabled
          - type: 'null'
          title: Truncation
          description: Truncation strategy.
        usage:
          anyOf:
          - $ref: '#/components/schemas/ResponseUsage'
          - type: 'null'
          description: Token usage details.
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: User identifier (use safety_identifier instead).
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - model
      - object
      - output
      - parallel_tool_calls
      - tool_choice
      - tools
      title: Response
      description: A model response from the Responses API.
    ResponseApplyPatchOperationCreateFile:
      properties:
        diff:
          type: string
          title: Diff
          description: Diff to apply.
        path:
          type: string
          title: Path
          description: Path of the file to create.
        type:
          type: string
          const: create_file
          title: Type
          description: Create a new file with the provided diff.
      additionalProperties: false
      type: object
      required:
      - diff
      - path
      - type
      title: ResponseApplyPatchOperationCreateFile
      description: Instruction describing how to create a file via the apply_patch
        tool.
    ResponseApplyPatchOperationDeleteFile:
      properties:
        path:
          type: string
          title: Path
          description: Path of the file to delete.
        type:
          type: string
          const: delete_file
          title: Type
          description: Delete the specified file.
      additionalProperties: false
      type: object
      required:
      - path
      - type
      title: ResponseApplyPatchOperationDeleteFile
      description: Instruction describing how to delete a file via the apply_patch
        tool.
    ResponseApplyPatchOperationUpdateFile:
      properties:
        diff:
          type: string
          title: Diff
          description: Diff to apply.
        path:
          type: string
          title: Path
          description: Path of the file to update.
        type:
          type: string
          const: update_file
          title: Type
          description: Update an existing file with the provided diff.
      additionalProperties: false
      type: object
      required:
      - diff
      - path
      - type
      title: ResponseApplyPatchOperationUpdateFile
      description: Instruction describing how to update a file via the apply_patch
        tool.
    ResponseApplyPatchToolCall:
      properties:
        id:
          type: string
          title: Id
          description: Apply patch tool call ID.
        call_id:
          type: string
          title: Call Id
          description: Model-generated apply patch call ID.
        operation:
          oneOf:
          - $ref: '#/components/schemas/ResponseApplyPatchOperationCreateFile'
          - $ref: '#/components/schemas/ResponseApplyPatchOperationDeleteFile'
          - $ref: '#/components/schemas/ResponseApplyPatchOperationUpdateFile'
          title: Operation
          description: Patch operation to apply.
          discriminator:
            propertyName: type
            mapping:
              create_file: '#/components/schemas/ResponseApplyPatchOperationCreateFile'
              delete_file: '#/components/schemas/ResponseApplyPatchOperationDeleteFile'
              update_file: '#/components/schemas/ResponseApplyPatchOperationUpdateFile'
        status:
          type: string
          enum:
          - in_progress
          - completed
          title: Status
          description: Apply patch status.
        type:
          type: string
          const: apply_patch_call
          title: Type
          description: Apply patch call type.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Tool call creator.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - operation
      - status
      - type
      title: ResponseApplyPatchToolCall
      description: A tool call that applies file diffs by creating, deleting, or updating
        files.
    ResponseApplyPatchToolCallOutput:
      properties:
        id:
          type: string
          title: Id
          description: Apply patch output ID.
        call_id:
          type: string
          title: Call Id
          description: Apply patch call ID.
        status:
          type: string
          enum:
          - completed
          - failed
          title: Status
          description: Output status.
        type:
          type: string
          const: apply_patch_call_output
          title: Type
          description: Apply patch output type.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Output creator.
        output:
          anyOf:
          - type: string
          - type: 'null'
          title: Output
          description: Textual output from apply patch.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - status
      - type
      title: ResponseApplyPatchToolCallOutput
      description: The output emitted by an apply patch tool call.
    ResponseCodeInterpreterToolCall:
      properties:
        id:
          type: string
          title: Id
          description: Code interpreter tool call ID.
        container_id:
          type: string
          title: Container Id
          description: Container ID.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          - interpreting
          - failed
          title: Status
          description: Code interpreter status.
        type:
          type: string
          const: code_interpreter_call
          title: Type
          description: Code interpreter call type.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Code to run.
        outputs:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/CodeInterpreterOutputLogs'
              - $ref: '#/components/schemas/CodeInterpreterOutputImage'
              discriminator:
                propertyName: type
                mapping:
                  image: '#/components/schemas/CodeInterpreterOutputImage'
                  logs: '#/components/schemas/CodeInterpreterOutputLogs'
            type: array
          - type: 'null'
          title: Outputs
          description: Code interpreter outputs (logs or images).
      additionalProperties: false
      type: object
      required:
      - id
      - container_id
      - status
      - type
      title: ResponseCodeInterpreterToolCall
      description: A tool call to run code.
    ResponseCompactionItem:
      properties:
        id:
          type: string
          title: Id
          description: Compaction item ID.
        encrypted_content:
          type: string
          title: Encrypted Content
          description: Encrypted compaction content.
        type:
          type: string
          const: compaction
          title: Type
          description: Compaction type.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Item creator.
      additionalProperties: false
      type: object
      required:
      - id
      - encrypted_content
      - type
      title: ResponseCompactionItem
      description: A compaction item generated by the v1/responses/compact API.
    ResponseComputerToolCall:
      properties:
        id:
          type: string
          title: Id
          description: Computer call ID.
        call_id:
          type: string
          title: Call Id
          description: Response identifier.
        pending_safety_checks:
          items:
            $ref: '#/components/schemas/PendingSafetyCheck'
          type: array
          title: Pending Safety Checks
          description: Pending safety checks.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Call status.
        type:
          type: string
          const: computer_call
          title: Type
          description: Computer call type.
        action:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ComputerActionClick'
            - $ref: '#/components/schemas/ComputerActionDoubleClick'
            - $ref: '#/components/schemas/ComputerActionDrag'
            - $ref: '#/components/schemas/ComputerActionKeypress'
            - $ref: '#/components/schemas/ComputerActionMove'
            - $ref: '#/components/schemas/ComputerActionScreenshot'
            - $ref: '#/components/schemas/ComputerActionScroll'
            - $ref: '#/components/schemas/ComputerActionType'
            - $ref: '#/components/schemas/ComputerActionWait'
            discriminator:
              propertyName: type
              mapping:
                click: '#/components/schemas/ComputerActionClick'
                double_click: '#/components/schemas/ComputerActionDoubleClick'
                drag: '#/components/schemas/ComputerActionDrag'
                keypress: '#/components/schemas/ComputerActionKeypress'
                move: '#/components/schemas/ComputerActionMove'
                screenshot: '#/components/schemas/ComputerActionScreenshot'
                scroll: '#/components/schemas/ComputerActionScroll'
                type: '#/components/schemas/ComputerActionType'
                wait: '#/components/schemas/ComputerActionWait'
          - type: 'null'
          title: Action
          description: Action to perform.
        actions:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/ComputerActionClick'
              - $ref: '#/components/schemas/ComputerActionDoubleClick'
              - $ref: '#/components/schemas/ComputerActionDrag'
              - $ref: '#/components/schemas/ComputerActionKeypress'
              - $ref: '#/components/schemas/ComputerActionMove'
              - $ref: '#/components/schemas/ComputerActionScreenshot'
              - $ref: '#/components/schemas/ComputerActionScroll'
              - $ref: '#/components/schemas/ComputerActionType'
              - $ref: '#/components/schemas/ComputerActionWait'
              discriminator:
                propertyName: type
                mapping:
                  click: '#/components/schemas/ComputerActionClick'
                  double_click: '#/components/schemas/ComputerActionDoubleClick'
                  drag: '#/components/schemas/ComputerActionDrag'
                  keypress: '#/components/schemas/ComputerActionKeypress'
                  move: '#/components/schemas/ComputerActionMove'
                  screenshot: '#/components/schemas/ComputerActionScreenshot'
                  scroll: '#/components/schemas/ComputerActionScroll'
                  type: '#/components/schemas/ComputerActionType'
                  wait: '#/components/schemas/ComputerActionWait'
            type: array
          - type: 'null'
          title: Actions
          description: Batched actions for computer_use.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - pending_safety_checks
      - status
      - type
      title: ResponseComputerToolCall
      description: A tool call to a computer use tool.
    ResponseComputerToolCallOutputItem:
      properties:
        id:
          type: string
          title: Id
          description: Computer call output ID.
        call_id:
          type: string
          title: Call Id
          description: Computer tool call ID.
        output:
          $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot'
          description: Computer screenshot.
        status:
          type: string
          enum:
          - completed
          - incomplete
          - failed
          - in_progress
          title: Status
          description: Output status.
        type:
          type: string
          const: computer_call_output
          title: Type
          description: Computer call output type.
        acknowledged_safety_checks:
          anyOf:
          - items:
              $ref: '#/components/schemas/AcknowledgedSafetyCheck'
            type: array
          - type: 'null'
          title: Acknowledged Safety Checks
          description: Acknowledged safety checks.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Item creator.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - output
      - status
      - type
      title: ResponseComputerToolCallOutputItem
      description: The output of a computer tool call.
    ResponseComputerToolCallOutputScreenshot:
      properties:
        type:
          type: string
          const: computer_screenshot
          title: Type
          description: Computer screenshot.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: Uploaded file with screenshot.
        image_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Url
          description: Screenshot URL.
      type: object
      required:
      - type
      title: ResponseComputerToolCallOutputScreenshot
      description: A computer screenshot image used with the computer use tool.
    ResponseConfigurationUpdateItem:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the configuration update item.
        type:
          type: string
          const: configuration_update
          title: Type
          description: The type of the item. Always `configuration_update`.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/ConfigurationUpdateReasoning'
          - type: 'null'
          description: Reasoning settings recorded by this item.
        text:
          anyOf:
          - $ref: '#/components/schemas/ConfigurationUpdateText'
          - type: 'null'
          description: Text output settings recorded by this item.
      additionalProperties: false
      type: object
      required:
      - id
      - type
      title: ResponseConfigurationUpdateItem
      description: A response configuration change recorded in conversation history.
    ResponseContainerReference:
      properties:
        container_id:
          type: string
          title: Container Id
          description: The container ID.
        type:
          type: string
          const: container_reference
          title: Type
          description: The environment type. Always `container_reference`.
      additionalProperties: false
      type: object
      required:
      - container_id
      - type
      title: ResponseContainerReference
      description: Represents a container created with /v1/containers.
    ResponseCreateParams:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: Model ID used to generate the response. Wildcard patterns are
            accepted and select the most recent matching model.
        input:
          anyOf:
          - type: string
          - items:
              anyOf:
              - $ref: '#/components/schemas/EasyInputMessage-Input'
              - $ref: '#/components/schemas/InputMessage'
              - $ref: '#/components/schemas/ComputerCallOutput'
              - $ref: '#/components/schemas/FunctionCallInput'
              - $ref: '#/components/schemas/FunctionCallOutput'
              - $ref: '#/components/schemas/ToolSearchCallInput'
              - $ref: '#/components/schemas/ToolSearchOutputInput'
              - $ref: '#/components/schemas/ImageGenerationCallInput'
              - $ref: '#/components/schemas/LocalShellCallInput'
              - $ref: '#/components/schemas/LocalShellCallOutputInput'
              - $ref: '#/components/schemas/ShellCall'
              - $ref: '#/components/schemas/ShellCallOutput'
              - $ref: '#/components/schemas/ApplyPatchCall'
              - $ref: '#/components/schemas/ApplyPatchCallOutput'
              - $ref: '#/components/schemas/McpListToolsInput'
              - $ref: '#/components/schemas/McpApprovalRequestInput'
              - $ref: '#/components/schemas/McpApprovalResponse'
              - $ref: '#/components/schemas/McpCallInput'
              - $ref: '#/components/schemas/WebSearchCallInput'
              - $ref: '#/components/schemas/FileSearchCallInput'
              - $ref: '#/components/schemas/CodeInterpreterCallInput'
              - $ref: '#/components/schemas/ComputerCallInput'
              - $ref: '#/components/schemas/CustomToolCallInput'
              - $ref: '#/components/schemas/CustomToolCallOutput'
              - $ref: '#/components/schemas/AdditionalToolsInput'
              - $ref: '#/components/schemas/ConfigurationUpdateInput'
              - $ref: '#/components/schemas/ProgramInput'
              - $ref: '#/components/schemas/ProgramOutputInput'
              - $ref: '#/components/schemas/CompactionTrigger'
              - $ref: '#/components/schemas/CompactionItemParam'
              - $ref: '#/components/schemas/ItemReference'
              - $ref: '#/components/schemas/ResponseOutputMessageInput-Input'
              - $ref: '#/components/schemas/ResponseReasoningItemInput'
            type: array
          - type: 'null'
          title: Input
          description: Text, image, or file inputs to the model, used to generate
            a response.
        background:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Background
          description: Whether to run the model response in the background. Accepted
            for compatibility and ignored.
        client_metadata:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Client Metadata
          description: Client environment metadata (sent by newer OpenAI clients such
            as Codex). Accepted for compatibility and ignored.
        context_management:
          anyOf:
          - items:
              $ref: '#/components/schemas/ContextManagement'
            type: array
            minItems: 1
          - type: 'null'
          title: Context Management
          description: 'Compacts the conversation before generation (never mid-response)
            once its input crosses `compact_threshold`: a `compaction` item then leads
            `output`, and sent back as input it stands for every item before it.'
        conversation:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ConversationObject'
          - type: 'null'
          title: Conversation
          description: 'The conversation this response belongs to: its items are prepended
            to the input, and the request''s input and the response''s output items
            are appended to it unless `store` is false. Cannot be used with `previous_response_id`.'
        include:
          anyOf:
          - items:
              type: string
              enum:
              - file_search_call.results
              - web_search_call.results
              - web_search_call.action.sources
              - message.input_image.image_url
              - computer_call_output.output.image_url
              - code_interpreter_call.outputs
              - reasoning.encrypted_content
              - message.output_text.logprobs
            type: array
          - type: 'null'
          title: Include
          description: Specify additional output data to include in the model response.
            `reasoning.encrypted_content` is honored (reasoning items carry a self-contained
            round-trip envelope) and `file_search_call.results` attaches the retrieved
            passages; other values are accepted and ignored.
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
          description: 'A system (or developer) message inserted into the model''s
            context. Not carried over by a `previous_response_id` continuation: send
            it again on each turn, or send a different one to swap it.'
        max_output_tokens:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Max Output Tokens
          description: An upper bound for the number of tokens that can be generated
            for a response.
        max_tool_calls:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Tool Calls
          description: 'The maximum number of total calls to built-in tools that can
            be processed in a response.

            UNSUPPORTED on this implementation.'
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Set of 16 key-value pairs that can be attached to an object.
        moderation:
          anyOf:
          - $ref: '#/components/schemas/RequestModeration'
          - type: 'null'
          description: Apply an AWS Bedrock guardrail to this request; results are
            reported in the response `moderation` field (on the terminal event when
            streaming).
        parallel_tool_calls:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Parallel Tool Calls
          description: Whether to allow the model to run tool calls in parallel.
        previous_response_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Response Id
          description: The unique ID of the previous response. Use to create multi-turn
            conversations; the previous response must have been created with `store=true`.
        prompt:
          anyOf:
          - $ref: '#/components/schemas/ResponsePrompt'
          - type: 'null'
          description: Reference to a prompt template and its variables. `id` must
            be an Amazon Bedrock Prompt Management prompt ARN, and the server must
            allow prompt ARNs. Variable values must be plain strings.
        prompt_cache_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Cache Key
          description: Cache key for similar requests.
        prompt_cache_options:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_responses__PromptCacheOptions'
          - type: 'null'
          description: Explicit prompt-caching configuration.
        prompt_cache_retention:
          anyOf:
          - type: string
            enum:
            - in_memory
            - 24h
            - 1h
            - 5m
          - type: 'null'
          title: Prompt Cache Retention
          description: Cache retention policy.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/Reasoning'
          - type: 'null'
          description: Reasoning configuration.
        safety_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Safety Identifier
          description: User policy violation identifier. Accepted for compatibility
            and ignored by generation; recorded in request logs.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - ultrafast
          - type: 'null'
          title: Service Tier
          description: 'Processing tier: `priority` (lowest, most consistent latency;
            `fast` is an alias), `flex` (cost-efficient); any other value is served
            on the standard tier. The response reports the requested tier after alias
            mapping.'
        store:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Store
          description: Persist the response for later retrieval and multi-turn continuation.
            Defaults to false on this implementation. Ignored (with a request-log
            warning) when streaming or when storage is not enabled on the server.
        stream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Stream
          description: Stream response as it is generated.
        stream_options:
          anyOf:
          - $ref: '#/components/schemas/StreamOptions'
          - type: 'null'
          description: Streaming options. Accepted for compatibility and ignored.
        temperature:
          anyOf:
          - type: number
            maximum: 2.0
            minimum: 0.0
          - type: 'null'
          title: Temperature
          description: Sampling temperature (0-2). Accepted and ignored on some models
            with fixed sampling.
        text:
          anyOf:
          - $ref: '#/components/schemas/ResponseTextConfig'
          - type: 'null'
          description: Text response config.
        tool_choice:
          anyOf:
          - type: string
            enum:
            - none
            - auto
            - required
          - $ref: '#/components/schemas/ToolChoiceAllowed'
          - $ref: '#/components/schemas/ToolChoiceTypes'
          - $ref: '#/components/schemas/ToolChoiceFunction'
          - $ref: '#/components/schemas/ToolChoiceMcp'
          - $ref: '#/components/schemas/ToolChoiceCustom'
          - $ref: '#/components/schemas/ToolChoiceApplyPatch'
          - $ref: '#/components/schemas/ToolChoiceShell'
          - $ref: '#/components/schemas/ToolChoiceProgrammaticToolCalling'
          - type: 'null'
          title: Tool Choice
          description: Tool selection method.
        tools:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
              - $ref: '#/components/schemas/FileSearchTool'
              - $ref: '#/components/schemas/ComputerTool'
              - $ref: '#/components/schemas/ComputerUsePreviewTool'
              - $ref: '#/components/schemas/WebSearchTool'
              - $ref: '#/components/schemas/Mcp'
              - $ref: '#/components/schemas/CodeInterpreter'
              - $ref: '#/components/schemas/ImageGeneration'
              - $ref: '#/components/schemas/LocalShell'
              - $ref: '#/components/schemas/FunctionShellTool'
              - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
              - $ref: '#/components/schemas/NamespaceTool'
              - $ref: '#/components/schemas/ToolSearchTool'
              - $ref: '#/components/schemas/WebSearchPreviewTool'
              - $ref: '#/components/schemas/ApplyPatchTool'
              - $ref: '#/components/schemas/ProgrammaticToolCalling'
              discriminator:
                propertyName: type
                mapping:
                  apply_patch: '#/components/schemas/ApplyPatchTool'
                  code_interpreter: '#/components/schemas/CodeInterpreter'
                  computer: '#/components/schemas/ComputerTool'
                  computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                  custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                  file_search: '#/components/schemas/FileSearchTool'
                  function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                  image_generation: '#/components/schemas/ImageGeneration'
                  local_shell: '#/components/schemas/LocalShell'
                  mcp: '#/components/schemas/Mcp'
                  namespace: '#/components/schemas/NamespaceTool'
                  programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                  shell: '#/components/schemas/FunctionShellTool'
                  tool_search: '#/components/schemas/ToolSearchTool'
                  web_search: '#/components/schemas/WebSearchTool'
                  web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                  web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                  web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
            type: array
          - type: 'null'
          title: Tools
          description: Available tools.
        top_logprobs:
          anyOf:
          - type: integer
            maximum: 20.0
            minimum: 0.0
          - type: 'null'
          title: Top Logprobs
          description: Top logprobs count (0-20).
        top_p:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Top P
          description: Nucleus sampling parameter. Accepted and ignored on some models
            with fixed sampling.
        truncation:
          anyOf:
          - type: string
            enum:
            - auto
            - disabled
          - type: 'null'
          title: Truncation
          description: 'What an input larger than the model''s context window gets.
            `disabled` (the default): a 400 `context_length_exceeded`. `auto`: its
            oldest turns are dropped, then the latest turn''s longest text is cut;
            still a 400 `context_length_exceeded` when what cannot be trimmed exceeds
            the window.'
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: User identifier (use safety_identifier instead).
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      title: ResponseCreateParams
      description: 'Request body for POST /v1/responses.


        Undeclared fields are forwarded to the model as extra parameters.'
    ResponseCustomToolCall:
      properties:
        call_id:
          type: string
          title: Call Id
          description: An identifier used to map this custom tool call to a tool call
            output.
        input:
          type: string
          title: Input
          description: The input for the custom tool call generated by the model.
        name:
          type: string
          title: Name
          description: The name of the custom tool being called.
        type:
          type: string
          const: custom_tool_call
          title: Type
          description: The type of the custom tool call. Always `custom_tool_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the custom tool call.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: The namespace of the custom tool being called.
      additionalProperties: false
      type: object
      required:
      - call_id
      - input
      - name
      - type
      title: ResponseCustomToolCall
      description: A call to a custom tool created by the model.
    ResponseCustomToolCallItem:
      properties:
        call_id:
          type: string
          title: Call Id
          description: An identifier used to map this custom tool call to a tool call
            output.
        input:
          type: string
          title: Input
          description: The input for the custom tool call generated by the model.
        name:
          type: string
          title: Name
          description: The name of the custom tool being called.
        type:
          type: string
          const: custom_tool_call
          title: Type
          description: The type of the custom tool call. Always `custom_tool_call`.
        id:
          type: string
          title: Id
          description: The unique ID of the custom tool call item.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: The namespace of the custom tool being called.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the item.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - call_id
      - input
      - name
      - type
      - id
      - status
      title: ResponseCustomToolCallItem
      description: A custom tool call item returned via API.
    ResponseCustomToolCallOutputItem:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The call ID, used to map this custom tool call output to a
            custom tool call.
        output:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Output
          description: The output from the custom tool call. Can be a string or a
            list of output content.
        type:
          type: string
          const: custom_tool_call_output
          title: Type
          description: The type of the custom tool call output. Always `custom_tool_call_output`.
        id:
          type: string
          title: Id
          description: The unique ID of the custom tool call output item.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the item.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - call_id
      - output
      - type
      - id
      - status
      title: ResponseCustomToolCallOutputItem
      description: A custom tool call output item returned via API.
    ResponseDeleted:
      properties:
        id:
          type: string
          title: Id
          description: Identifier of the deleted response.
        object:
          type: string
          const: response.deleted
          title: Object
          description: The object type, which is always `response.deleted`.
          default: response.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Whether the response was deleted.
          default: true
      additionalProperties: false
      type: object
      required:
      - id
      title: ResponseDeleted
      description: Stored response deletion confirmation.
    ResponseError:
      properties:
        code:
          type: string
          enum:
          - server_error
          - rate_limit_exceeded
          - context_length_exceeded
          - invalid_prompt
          - data_residency_mismatch
          - bio_policy
          - vector_store_timeout
          - invalid_image
          - invalid_image_format
          - invalid_base64_image
          - invalid_image_url
          - image_too_large
          - image_too_small
          - image_parse_error
          - image_content_policy_violation
          - invalid_image_mode
          - image_file_too_large
          - unsupported_image_media_type
          - empty_image_file
          - failed_to_download_image
          - image_file_not_found
          title: Code
          description: Error code.
        message:
          type: string
          title: Message
          description: Error message.
      additionalProperties: false
      type: object
      required:
      - code
      - message
      title: ResponseError
      description: An error object returned when the model fails to generate a response.
    ResponseFileSearchToolCall:
      properties:
        id:
          type: string
          title: Id
          description: File search tool call ID.
        queries:
          items:
            type: string
          type: array
          title: Queries
          description: Search queries.
        status:
          type: string
          enum:
          - in_progress
          - searching
          - completed
          - incomplete
          - failed
          title: Status
          description: File search status.
        type:
          type: string
          const: file_search_call
          title: Type
          description: File search call type.
        results:
          anyOf:
          - items:
              $ref: '#/components/schemas/FileSearchResult'
            type: array
          - type: 'null'
          title: Results
          description: File search results.
      additionalProperties: false
      type: object
      required:
      - id
      - queries
      - status
      - type
      title: ResponseFileSearchToolCall
      description: The results of a file search tool call.
    ResponseFormatJSONObject:
      properties:
        type:
          type: string
          const: json_object
          title: Type
          description: The type of response format. Always `json_object`.
          default: json_object
      additionalProperties: false
      type: object
      title: ResponseFormatJSONObject
      description: The type of response format being defined.
    ResponseFormatJSONSchema:
      properties:
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Whether to enable strict schema adherence when generating the
            function call. If true, the model follows the exact schema in `parameters`;
            only a subset of JSON Schema is supported in that case.
        type:
          type: string
          const: json_schema
          title: Type
          description: The type of response format. Always `json_schema`.
          default: json_schema
        json_schema:
          $ref: '#/components/schemas/JSONSchema'
          description: Structured Outputs JSON Schema configuration.
      type: object
      required:
      - json_schema
      title: ResponseFormatJSONSchema
      description: "Structured Outputs configuration options, including a JSON Schema.\n\
        \nAttributes:\n    type: Must be \"json_schema\".\n    json_schema: Structured\
        \ Outputs JSON Schema configuration."
    ResponseFormatText:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: The type of response format. Always `text`.
          default: text
      additionalProperties: false
      type: object
      title: ResponseFormatText
      description: The type of response format being defined.
    ResponseFormatTextJSONSchemaConfig:
      properties:
        name:
          type: string
          title: Name
          description: Response format name (a-z, A-Z, 0-9, underscores, dashes; max
            64 chars).
        schema:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Schema
          description: JSON Schema for response format.
        type:
          type: string
          const: json_schema
          title: Type
          description: JSON schema response format.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of the response format for the model.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema adherence.
      type: object
      required:
      - name
      - schema
      - type
      title: ResponseFormatTextJSONSchemaConfig
      description: JSON Schema response format for generating structured JSON responses.
    ResponseFunctionShellToolCall:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the shell tool call.
        action:
          $ref: '#/components/schemas/ResponseFunctionShellToolCallAction'
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the shell tool call generated by the model.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the shell call.
        type:
          type: string
          const: shell_call
          title: Type
          description: The type of the item. Always `shell_call`.
        environment:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ResponseLocalEnvironment'
            - $ref: '#/components/schemas/ResponseContainerReference'
            discriminator:
              propertyName: type
              mapping:
                container_reference: '#/components/schemas/ResponseContainerReference'
                local: '#/components/schemas/ResponseLocalEnvironment'
          - type: 'null'
          title: Environment
          description: Represents the use of a local environment to perform shell
            actions.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The ID of the entity that created this tool call.
      additionalProperties: false
      type: object
      required:
      - id
      - action
      - call_id
      - status
      - type
      title: ResponseFunctionShellToolCall
      description: A tool call that executes one or more shell commands in a managed
        environment.
    ResponseFunctionShellToolCallAction:
      properties:
        commands:
          items:
            type: string
          type: array
          title: Commands
          description: The shell commands to execute.
        max_output_length:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Output Length
          description: Optional maximum number of characters to return from each command.
        timeout_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Timeout Ms
          description: Optional timeout in milliseconds for the commands.
      additionalProperties: false
      type: object
      required:
      - commands
      title: ResponseFunctionShellToolCallAction
      description: The shell commands and limits that describe how to run the tool
        call.
    ResponseFunctionShellToolCallOutput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the shell call output.
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the shell tool call generated by the model.
        output:
          items:
            $ref: '#/components/schemas/ShellToolCallOutputContent'
          type: array
          title: Output
          description: An array of shell call output contents.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the shell call output.
        type:
          type: string
          const: shell_call_output
          title: Type
          description: The type of the shell call output. Always `shell_call_output`.
        max_output_length:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Output Length
          description: The maximum length of the shell command output.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - output
      - status
      - type
      title: ResponseFunctionShellToolCallOutput
      description: The output of a shell tool call that was emitted.
    ResponseFunctionToolCall:
      properties:
        arguments:
          type: string
          title: Arguments
          description: JSON string of function arguments.
        call_id:
          type: string
          title: Call Id
          description: Function tool call ID.
        name:
          type: string
          title: Name
          description: Function name.
        type:
          type: string
          const: function_call
          title: Type
          description: Function call type.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Function call unique ID.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: Function namespace.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: 'Item status: `in_progress`, `completed`, or `incomplete`.'
      additionalProperties: false
      type: object
      required:
      - arguments
      - call_id
      - name
      - type
      title: ResponseFunctionToolCall
      description: A tool call to run a function.
    ResponseFunctionToolCallItem:
      properties:
        arguments:
          type: string
          title: Arguments
          description: JSON string of function arguments.
        call_id:
          type: string
          title: Call Id
          description: Function tool call ID.
        name:
          type: string
          title: Name
          description: Function name.
        type:
          type: string
          const: function_call
          title: Type
          description: Function call type.
        id:
          type: string
          title: Id
          description: The unique ID of the function tool call.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        namespace:
          anyOf:
          - type: string
          - type: 'null'
          title: Namespace
          description: Function namespace.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the item.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - arguments
      - call_id
      - name
      - type
      - id
      - status
      title: ResponseFunctionToolCallItem
      description: A function tool call item returned via API.
    ResponseFunctionToolCallOutputItem:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the function call tool output.
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the function tool call generated by the model.
        output:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
            type: array
          title: Output
          description: The output from the function call. Can be a string or a list
            of output content.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the item.
        type:
          type: string
          const: function_call_output
          title: Type
          description: The type of the function tool call output. Always `function_call_output`.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - id
      - call_id
      - output
      - status
      - type
      title: ResponseFunctionToolCallOutputItem
      description: A function tool call output item returned via API.
    ResponseFunctionWebSearch:
      properties:
        id:
          type: string
          title: Id
          description: Web search tool call ID.
        action:
          oneOf:
          - $ref: '#/components/schemas/WebSearchActionSearch'
          - $ref: '#/components/schemas/WebSearchActionOpenPage'
          - $ref: '#/components/schemas/WebSearchActionFind'
          title: Action
          description: Web search action taken.
          discriminator:
            propertyName: type
            mapping:
              find_in_page: '#/components/schemas/WebSearchActionFind'
              open_page: '#/components/schemas/WebSearchActionOpenPage'
              search: '#/components/schemas/WebSearchActionSearch'
        status:
          type: string
          enum:
          - in_progress
          - searching
          - completed
          - incomplete
          - failed
          title: Status
          description: Web search status.
        type:
          type: string
          const: web_search_call
          title: Type
          description: Web search call type.
      additionalProperties: false
      type: object
      required:
      - id
      - action
      - status
      - type
      title: ResponseFunctionWebSearch
      description: The results of a web search tool call.
    ResponseInputFile:
      properties:
        type:
          type: string
          const: input_file
          title: Type
          description: Input file type.
        file_data:
          anyOf:
          - type: string
          - type: 'null'
          title: File Data
          description: File content.
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: File ID.
        file_url:
          anyOf:
          - type: string
          - type: 'null'
          title: File Url
          description: File URL.
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: Filename.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/PromptCacheBreakpoint-Output'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      title: ResponseInputFile
      description: A file input to the model.
    ResponseInputImage:
      properties:
        type:
          type: string
          const: input_image
          title: Type
          description: Input image type.
        detail:
          anyOf:
          - type: string
            enum:
            - low
            - high
            - auto
            - original
          - type: 'null'
          title: Detail
          description: 'Image detail level: `high`, `low`, `auto`, or `original`.
            Default: auto.'
        file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: File Id
          description: Image file ID.
        image_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Url
          description: Image URL or base64 data URL.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/PromptCacheBreakpoint-Output'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      title: ResponseInputImage
      description: An image input to the model.
    ResponseInputMessageItem:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the message input.
        content:
          items:
            oneOf:
            - $ref: '#/components/schemas/ResponseInputText'
            - $ref: '#/components/schemas/ResponseInputImage'
            - $ref: '#/components/schemas/ResponseInputFile'
            - $ref: '#/components/schemas/ResponseOutputTextContent'
            discriminator:
              propertyName: type
              mapping:
                input_file: '#/components/schemas/ResponseInputFile'
                input_image: '#/components/schemas/ResponseInputImage'
                input_text: '#/components/schemas/ResponseInputText'
                output_text: '#/components/schemas/ResponseOutputTextContent'
          type: array
          title: Content
          description: A list of one or many input items to the model, containing
            different content types.
        role:
          type: string
          enum:
          - user
          - system
          - developer
          title: Role
          description: The role of the message input. One of `user`, `system`, or
            `developer`.
        type:
          type: string
          const: message
          title: Type
          description: The type of the message input. Always set to `message`.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of item. One of `in_progress`, `completed`, or `incomplete`.
      additionalProperties: false
      type: object
      required:
      - id
      - content
      - role
      - type
      title: ResponseInputMessageItem
      description: A message input item returned from the items API.
    ResponseInputText:
      properties:
        text:
          type: string
          title: Text
          description: Text input.
        type:
          type: string
          const: input_text
          title: Type
          description: Input text type.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/PromptCacheBreakpoint-Output'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - text
      - type
      title: ResponseInputText
      description: A text input to the model.
    ResponseItemList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        data:
          items:
            anyOf:
            - $ref: '#/components/schemas/ResponseInputMessageItem'
            - $ref: '#/components/schemas/ResponseOutputMessage'
            - $ref: '#/components/schemas/ResponseOutputMessageInput-Output'
            - $ref: '#/components/schemas/ResponseFileSearchToolCall'
            - $ref: '#/components/schemas/FileSearchCallInput'
            - $ref: '#/components/schemas/ResponseComputerToolCall'
            - $ref: '#/components/schemas/ComputerCallInput'
            - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseFunctionWebSearch'
            - $ref: '#/components/schemas/WebSearchCallInput'
            - $ref: '#/components/schemas/ResponseFunctionToolCallItem'
            - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem'
            - $ref: '#/components/schemas/ResponseToolSearchCall'
            - $ref: '#/components/schemas/ToolSearchCallInput'
            - $ref: '#/components/schemas/ResponseToolSearchOutputItem'
            - $ref: '#/components/schemas/ToolSearchOutputInput'
            - $ref: '#/components/schemas/AdditionalTools'
            - $ref: '#/components/schemas/ResponseConfigurationUpdateItem'
            - $ref: '#/components/schemas/ResponseReasoningItem'
            - $ref: '#/components/schemas/ResponseReasoningItemInput'
            - $ref: '#/components/schemas/ResponseCompactionItem'
            - $ref: '#/components/schemas/ImageGenerationCall'
            - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall'
            - $ref: '#/components/schemas/CodeInterpreterCallInput'
            - $ref: '#/components/schemas/LocalShellCall'
            - $ref: '#/components/schemas/LocalShellCallOutput'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCall'
            - $ref: '#/components/schemas/ShellCall'
            - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCall'
            - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput'
            - $ref: '#/components/schemas/McpListTools'
            - $ref: '#/components/schemas/McpApprovalRequest'
            - $ref: '#/components/schemas/McpApprovalResponseOutput'
            - $ref: '#/components/schemas/McpCall'
            - $ref: '#/components/schemas/ResponseCustomToolCallItem'
            - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem'
            - $ref: '#/components/schemas/Program'
            - $ref: '#/components/schemas/ProgramOutput'
          type: array
          title: Data
          description: A list of items used to generate this response.
        object:
          type: string
          const: list
          title: Object
          description: The type of object returned. Always `list`.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      - object
      title: ResponseItemList
      description: A paginated list of Response items.
    ResponseLocalEnvironment:
      properties:
        type:
          type: string
          const: local
          title: Type
          description: The environment type. Always `local`.
      additionalProperties: false
      type: object
      required:
      - type
      title: ResponseLocalEnvironment
      description: Represents the use of a local environment to perform shell actions.
    ResponseMessage:
      properties:
        role:
          type: string
          const: assistant
          title: Role
          description: Always `assistant`.
        content:
          type: string
          title: Content
          description: Assistant message text.
          default: ''
        thinking:
          anyOf:
          - type: string
          - type: 'null'
          title: Thinking
          description: Thinking text, when `think` is enabled.
        tool_calls:
          anyOf:
          - items:
              $ref: '#/components/schemas/ToolCall'
            type: array
          - type: 'null'
          title: Tool Calls
          description: Tool calls the assistant requested.
      additionalProperties: false
      type: object
      required:
      - role
      title: ResponseMessage
      description: Assistant message returned by the chat endpoint.
    ResponseModeration:
      properties:
        input:
          $ref: '#/components/schemas/ModerationResult'
          description: Moderation result for the request input.
        output:
          $ref: '#/components/schemas/ModerationResult'
          description: Moderation result for the generated output.
      additionalProperties: false
      type: object
      required:
      - input
      - output
      title: ResponseModeration
      description: Moderation results for the request input and generated output.
    ResponseOutputMessage:
      properties:
        id:
          type: string
          title: Id
          description: Output message ID.
        content:
          items:
            oneOf:
            - $ref: '#/components/schemas/ResponseOutputText-Output'
            - $ref: '#/components/schemas/ResponseOutputRefusal'
            discriminator:
              propertyName: type
              mapping:
                output_text: '#/components/schemas/ResponseOutputText-Output'
                refusal: '#/components/schemas/ResponseOutputRefusal'
          type: array
          title: Content
          description: Message content.
        role:
          type: string
          const: assistant
          title: Role
          description: Assistant role.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Message status.
        type:
          type: string
          const: message
          title: Type
          description: Message type.
        phase:
          anyOf:
          - type: string
            enum:
            - commentary
            - final_answer
          - type: 'null'
          title: Phase
          description: Labels assistant message as commentary or final answer.
      additionalProperties: false
      type: object
      required:
      - id
      - content
      - role
      - status
      - type
      title: ResponseOutputMessage
      description: An output message from the model.
    ResponseOutputMessageInput-Input:
      properties:
        id:
          type: string
          title: Id
          description: Output message ID.
        content:
          items:
            anyOf:
            - oneOf:
              - $ref: '#/components/schemas/ResponseOutputText-Input'
              - $ref: '#/components/schemas/ResponseOutputRefusal'
              discriminator:
                propertyName: type
                mapping:
                  output_text: '#/components/schemas/ResponseOutputText-Input'
                  refusal: '#/components/schemas/ResponseOutputRefusal'
            - oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
          type: array
          title: Content
          description: Message content.
        role:
          type: string
          const: assistant
          title: Role
          description: Assistant role.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Message status.
        type:
          type: string
          const: message
          title: Type
          description: Message type.
        phase:
          anyOf:
          - type: string
            enum:
            - commentary
            - final_answer
          - type: 'null'
          title: Phase
          description: Labels assistant message as commentary or final answer.
      type: object
      required:
      - id
      - content
      - role
      - status
      - type
      title: ResponseOutputMessageInput
      description: 'An echoed output message accepted as an input item (ignores unknown
        fields).


        The content parts are widened to the input shapes as well: a client replaying

        an assistant turn may relabel its text parts as ``input_text`` rather than

        ``output_text`` -- Codex does -- and the item is only being read back, so
        the

        label carries nothing to act on. Refusing it would fail the turn over an echo

        of the gateway''s own output.'
    ResponseOutputMessageInput-Output:
      properties:
        id:
          type: string
          title: Id
          description: Output message ID.
        content:
          items:
            anyOf:
            - oneOf:
              - $ref: '#/components/schemas/ResponseOutputText-Output'
              - $ref: '#/components/schemas/ResponseOutputRefusal'
              discriminator:
                propertyName: type
                mapping:
                  output_text: '#/components/schemas/ResponseOutputText-Output'
                  refusal: '#/components/schemas/ResponseOutputRefusal'
            - oneOf:
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
              - $ref: '#/components/schemas/ResponseOutputTextContent'
              discriminator:
                propertyName: type
                mapping:
                  input_file: '#/components/schemas/ResponseInputFile'
                  input_image: '#/components/schemas/ResponseInputImage'
                  input_text: '#/components/schemas/ResponseInputText'
                  output_text: '#/components/schemas/ResponseOutputTextContent'
          type: array
          title: Content
          description: Message content.
        role:
          type: string
          const: assistant
          title: Role
          description: Assistant role.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Message status.
        type:
          type: string
          const: message
          title: Type
          description: Message type.
        phase:
          anyOf:
          - type: string
            enum:
            - commentary
            - final_answer
          - type: 'null'
          title: Phase
          description: Labels assistant message as commentary or final answer.
      type: object
      required:
      - id
      - content
      - role
      - status
      - type
      title: ResponseOutputMessageInput
      description: 'An echoed output message accepted as an input item (ignores unknown
        fields).


        The content parts are widened to the input shapes as well: a client replaying

        an assistant turn may relabel its text parts as ``input_text`` rather than

        ``output_text`` -- Codex does -- and the item is only being read back, so
        the

        label carries nothing to act on. Refusing it would fail the turn over an echo

        of the gateway''s own output.'
    ResponseOutputRefusal:
      properties:
        refusal:
          type: string
          title: Refusal
          description: Refusal explanation.
        type:
          type: string
          const: refusal
          title: Type
          description: Refusal type.
      additionalProperties: false
      type: object
      required:
      - refusal
      - type
      title: ResponseOutputRefusal
      description: A refusal from the model.
    ResponseOutputText-Input:
      properties:
        annotations:
          items:
            oneOf:
            - $ref: '#/components/schemas/AnnotationFileCitation'
            - $ref: '#/components/schemas/AnnotationURLCitation-Input'
            - $ref: '#/components/schemas/AnnotationContainerFileCitation'
            - $ref: '#/components/schemas/AnnotationFilePath'
            discriminator:
              propertyName: type
              mapping:
                container_file_citation: '#/components/schemas/AnnotationContainerFileCitation'
                file_citation: '#/components/schemas/AnnotationFileCitation'
                file_path: '#/components/schemas/AnnotationFilePath'
                url_citation: '#/components/schemas/AnnotationURLCitation-Input'
          type: array
          title: Annotations
          description: Text annotations.
        text:
          type: string
          title: Text
          description: Model text output.
        type:
          type: string
          const: output_text
          title: Type
          description: Output text type.
        logprobs:
          anyOf:
          - items:
              $ref: '#/components/schemas/Logprob'
            type: array
          - type: 'null'
          title: Logprobs
          description: Output token log probabilities.
      additionalProperties: false
      type: object
      required:
      - annotations
      - text
      - type
      title: ResponseOutputText
      description: A text output from the model.
    ResponseOutputText-Output:
      properties:
        annotations:
          items:
            oneOf:
            - $ref: '#/components/schemas/AnnotationFileCitation'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__AnnotationURLCitation'
            - $ref: '#/components/schemas/AnnotationContainerFileCitation'
            - $ref: '#/components/schemas/AnnotationFilePath'
            discriminator:
              propertyName: type
              mapping:
                container_file_citation: '#/components/schemas/AnnotationContainerFileCitation'
                file_citation: '#/components/schemas/AnnotationFileCitation'
                file_path: '#/components/schemas/AnnotationFilePath'
                url_citation: '#/components/schemas/stdapi__types__openai_responses__AnnotationURLCitation'
          type: array
          title: Annotations
          description: Text annotations.
        text:
          type: string
          title: Text
          description: Model text output.
        type:
          type: string
          const: output_text
          title: Type
          description: Output text type.
        logprobs:
          anyOf:
          - items:
              $ref: '#/components/schemas/Logprob'
            type: array
          - type: 'null'
          title: Logprobs
          description: Output token log probabilities.
      additionalProperties: false
      type: object
      required:
      - annotations
      - text
      - type
      title: ResponseOutputText
      description: A text output from the model.
    ResponseOutputTextContent:
      properties:
        type:
          type: string
          const: output_text
          title: Type
          description: Output text type.
        text:
          type: string
          title: Text
          description: Text content from assistant response.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - type
      - text
      title: ResponseOutputTextContent
      description: An output_text content block echoed back in the input array (previous
        assistant response).
    ResponsePrompt:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the prompt template to use.
        variables:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: string
              - $ref: '#/components/schemas/ResponseInputText'
              - $ref: '#/components/schemas/ResponseInputImage'
              - $ref: '#/components/schemas/ResponseInputFile'
            type: object
          - type: 'null'
          title: Variables
          description: Optional map of values to substitute in for variables in the
            prompt template.
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
          description: Optional version of the prompt template.
      additionalProperties: false
      type: object
      required:
      - id
      title: ResponsePrompt
      description: Reference to a prompt template and its variables.
    ResponseReasoningItem:
      properties:
        id:
          type: string
          title: Id
          description: Reasoning content ID.
        summary:
          items:
            $ref: '#/components/schemas/ReasoningItemSummary'
          type: array
          title: Summary
          description: Reasoning summary.
        type:
          type: string
          const: reasoning
          title: Type
          description: Reasoning type.
        content:
          anyOf:
          - items:
              $ref: '#/components/schemas/ReasoningItemContent'
            type: array
          - type: 'null'
          title: Content
          description: Reasoning text content.
        encrypted_content:
          anyOf:
          - type: string
          - type: 'null'
          title: Encrypted Content
          description: Encrypted reasoning content when included.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: 'Status: `in_progress`, `completed`, or `incomplete`.'
      additionalProperties: false
      type: object
      required:
      - id
      - summary
      - type
      title: ResponseReasoningItem
      description: A description of the chain of thought used by a reasoning model
        while generating a response.
    ResponseReasoningItemInput:
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: Reasoning content ID.
        summary:
          items:
            $ref: '#/components/schemas/ReasoningItemSummary'
          type: array
          title: Summary
          description: Reasoning summary.
        type:
          type: string
          const: reasoning
          title: Type
          description: Reasoning type.
        content:
          anyOf:
          - items:
              $ref: '#/components/schemas/ReasoningItemContentInput'
            type: array
          - type: 'null'
          title: Content
          description: Reasoning text content.
        encrypted_content:
          anyOf:
          - type: string
          - type: 'null'
          title: Encrypted Content
          description: Encrypted reasoning content when included.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: 'Status: `in_progress`, `completed`, or `incomplete`.'
      type: object
      required:
      - type
      title: ResponseReasoningItemInput
      description: 'An echoed reasoning item accepted as an input item (ignores unknown
        fields).


        Tolerates client serializations seen in the wild (Codex): a missing

        ``summary``, a null ``id``, and ``text``-typed content parts.'
    ResponseTextConfig:
      properties:
        format:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ResponseFormatText'
            - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
            - $ref: '#/components/schemas/ResponseFormatJSONObject'
            discriminator:
              propertyName: type
              mapping:
                json_object: '#/components/schemas/ResponseFormatJSONObject'
                json_schema: '#/components/schemas/ResponseFormatTextJSONSchemaConfig'
                text: '#/components/schemas/ResponseFormatText'
          - type: 'null'
          title: Format
          description: 'An object specifying the format that the model must output.
            Configuring `{ "type": "json_schema" }` enables Structured Outputs.'
        verbosity:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
          - type: 'null'
          title: Verbosity
          description: 'Constrains the verbosity of the model''s response. Values:
            `low`, `medium`, or `high`.'
      type: object
      title: ResponseTextConfig
      description: Configuration options for a text response from the model.
    ResponseToolSearchCall:
      properties:
        id:
          type: string
          title: Id
          description: Tool search call ID.
        arguments:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Arguments
          description: Tool search arguments.
        execution:
          type: string
          enum:
          - server
          - client
          title: Execution
          description: Server or client execution.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: Call status.
        type:
          type: string
          const: tool_search_call
          title: Type
          description: Tool search call type.
        call_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Call Id
          description: Model-generated call ID.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Item creator.
      additionalProperties: false
      type: object
      required:
      - id
      - arguments
      - execution
      - status
      - type
      title: ResponseToolSearchCall
      description: A tool search call item.
    ResponseToolSearchOutputItem:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the tool search output item.
        execution:
          type: string
          enum:
          - server
          - client
          title: Execution
          description: Whether tool search was executed by the server or by the client.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - incomplete
          title: Status
          description: The status of the tool search output item that was recorded.
        tools:
          items:
            oneOf:
            - $ref: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
            - $ref: '#/components/schemas/FileSearchTool'
            - $ref: '#/components/schemas/ComputerTool'
            - $ref: '#/components/schemas/ComputerUsePreviewTool'
            - $ref: '#/components/schemas/WebSearchTool'
            - $ref: '#/components/schemas/Mcp'
            - $ref: '#/components/schemas/CodeInterpreter'
            - $ref: '#/components/schemas/ImageGeneration'
            - $ref: '#/components/schemas/LocalShell'
            - $ref: '#/components/schemas/FunctionShellTool'
            - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
            - $ref: '#/components/schemas/NamespaceTool'
            - $ref: '#/components/schemas/ToolSearchTool'
            - $ref: '#/components/schemas/WebSearchPreviewTool'
            - $ref: '#/components/schemas/ApplyPatchTool'
            - $ref: '#/components/schemas/ProgrammaticToolCalling'
            discriminator:
              propertyName: type
              mapping:
                apply_patch: '#/components/schemas/ApplyPatchTool'
                code_interpreter: '#/components/schemas/CodeInterpreter'
                computer: '#/components/schemas/ComputerTool'
                computer_use_preview: '#/components/schemas/ComputerUsePreviewTool'
                custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool'
                file_search: '#/components/schemas/FileSearchTool'
                function: '#/components/schemas/stdapi__types__openai_responses__FunctionTool'
                image_generation: '#/components/schemas/ImageGeneration'
                local_shell: '#/components/schemas/LocalShell'
                mcp: '#/components/schemas/Mcp'
                namespace: '#/components/schemas/NamespaceTool'
                programmatic_tool_calling: '#/components/schemas/ProgrammaticToolCalling'
                shell: '#/components/schemas/FunctionShellTool'
                tool_search: '#/components/schemas/ToolSearchTool'
                web_search: '#/components/schemas/WebSearchTool'
                web_search_2025_08_26: '#/components/schemas/WebSearchTool'
                web_search_preview: '#/components/schemas/WebSearchPreviewTool'
                web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool'
          type: array
          title: Tools
          description: The loaded tool definitions returned by tool search.
        type:
          type: string
          const: tool_search_output
          title: Type
          description: The type of the item. Always `tool_search_output`.
        call_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Call Id
          description: The unique ID of the tool search call generated by the model.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - id
      - execution
      - status
      - tools
      - type
      title: ResponseToolSearchOutputItem
      description: A tool search output item.
    ResponseUsage:
      properties:
        input_tokens:
          type: integer
          title: Input Tokens
          description: Input token count.
        input_tokens_details:
          $ref: '#/components/schemas/InputTokensDetails'
          description: Input token details.
        output_tokens:
          type: integer
          title: Output Tokens
          description: Output token count.
        output_tokens_details:
          $ref: '#/components/schemas/stdapi__types__openai_responses__OutputTokensDetails'
          description: Output token details.
        total_tokens:
          type: integer
          title: Total Tokens
          description: Total token count.
      additionalProperties: false
      type: object
      required:
      - input_tokens
      - input_tokens_details
      - output_tokens
      - output_tokens_details
      - total_tokens
      title: ResponseUsage
      description: Token usage details for a response, including input, output, and
        total counts.
    SageMakerEndpointConfig:
      properties:
        endpoint:
          type: string
          title: Endpoint
          description: 'Name of the Amazon SageMaker AI endpoint serving this model.
            The name, never the ARN: the ARN carries your AWS account ID.


            Example: ''my-endpoint'''
        region:
          $ref: '#/components/schemas/RegionName'
          description: 'AWS Region the endpoint lives in. An endpoint answers only
            in its own Region and has no cross-Region form.


            Example: ''us-east-1'''
        inference_component:
          type: string
          title: Inference Component
          description: 'Name of the inference component hosting the model on the endpoint,
            for an endpoint that hosts components. Required for scale-to-zero endpoints,
            which are always component-hosted.


            Example: ''my-inference-component'''
          default: ''
        name:
          type: string
          title: Name
          description: 'Display name published for this model. Defaults to the model
            ID.


            Example: ''Qwen3 1.7B'''
          default: ''
        provider:
          type: string
          title: Provider
          description: 'Provider published for this model.


            Example: ''Qwen'''
          default: Amazon SageMaker AI
        input_modalities:
          items:
            type: string
          type: array
          title: Input Modalities
          description: 'Input modalities published for this model, advertised so a
            client can discover them. ''IMAGE'' additionally requires a container
            and a model that accept image content parts.


            Example: [''TEXT'', ''IMAGE'']'
          default:
          - TEXT
      additionalProperties: false
      type: object
      required:
      - endpoint
      - region
      title: SageMakerEndpointConfig
      description: 'An Amazon SageMaker AI endpoint published as a chat model.


        An endpoint is named rather than discovered: only the operator knows which

        of their endpoints runs a container serving the OpenAI Chat Completions

        API, and what the model behind it should be called.'
    SearchResultBlockParam:
      properties:
        type:
          type: string
          const: search_result
          title: Type
          description: Content block type. Always `search_result`.
        content:
          items:
            $ref: '#/components/schemas/TextBlockParam'
          type: array
          title: Content
          description: The content of the search result.
        source:
          type: string
          title: Source
          description: The source URL of the search result.
        title:
          type: string
          title: Title
          description: Title of the search result.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        citations:
          anyOf:
          - $ref: '#/components/schemas/CitationsConfigParam'
          - type: 'null'
          description: Citations configuration for the search result.
      type: object
      required:
      - type
      - content
      - source
      - title
      title: SearchResultBlockParam
      description: Search result content block parameter.
    SearchResultContent:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Always `text`.
          default: text
        text:
          type: string
          title: Text
          description: The matching text.
      additionalProperties: false
      type: object
      required:
      - text
      title: SearchResultContent
      description: One piece of content returned by a search.
    ServerToolCaller:
      properties:
        tool_id:
          type: string
          title: Tool Id
          description: The tool identifier.
        type:
          type: string
          pattern: ^code_execution(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - tool_id
      - type
      title: ServerToolCaller
      description: Tool invocation generated by a server-side tool.
    ServerToolUsage:
      properties:
        web_search_requests:
          type: integer
          title: Web Search Requests
          description: Web search requests.
        web_fetch_requests:
          type: integer
          title: Web Fetch Requests
          description: Web fetch requests.
      additionalProperties: false
      type: object
      required:
      - web_search_requests
      - web_fetch_requests
      title: ServerToolUsage
      description: Server tool usage.
    ServerToolUseBlock:
      properties:
        type:
          type: string
          const: server_tool_use
          title: Type
          description: Content block type. Always `server_tool_use`.
        id:
          type: string
          title: Id
          description: Unique identifier for this server tool use.
        name:
          type: string
          title: Name
          description: Name of the server tool being used.
        input:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Input
          description: Tool input parameters as a JSON object.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
      additionalProperties: false
      type: object
      required:
      - type
      - id
      - name
      - input
      title: ServerToolUseBlock
      description: Server-side tool use content block.
    ServerToolUseBlockParam:
      properties:
        type:
          type: string
          const: server_tool_use
          title: Type
          description: Content block type. Always `server_tool_use`.
        id:
          type: string
          title: Id
          description: Unique identifier for this server tool use.
        name:
          type: string
          title: Name
          description: Name of the server tool being used.
        input:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Input
          description: Tool input parameters as a JSON object.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
      type: object
      required:
      - type
      - id
      - name
      - input
      title: ServerToolUseBlockParam
      description: Server-side tool use content block parameter.
    ShellCall:
      properties:
        action:
          $ref: '#/components/schemas/ShellCallAction'
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the shell tool call generated by the model.
        type:
          type: string
          const: shell_call
          title: Type
          description: The type of the item. Always `shell_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the shell tool call. Populated when this item
            is returned via API.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        environment:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/LocalEnvironment'
            - $ref: '#/components/schemas/ContainerReference'
            discriminator:
              propertyName: type
              mapping:
                container_reference: '#/components/schemas/ContainerReference'
                local: '#/components/schemas/LocalEnvironment'
          - type: 'null'
          title: Environment
          description: The environment to execute the shell commands in.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the shell call.
      type: object
      required:
      - action
      - call_id
      - type
      title: ShellCall
      description: A tool representing a request to execute one or more shell commands.
    ShellCallAction:
      properties:
        commands:
          items:
            type: string
          type: array
          title: Commands
          description: Ordered shell commands for the execution environment to run.
        max_output_length:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Output Length
          description: Maximum number of UTF-8 characters to capture from combined
            stdout and stderr output.
        timeout_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Timeout Ms
          description: Maximum wall-clock time in milliseconds to allow the shell
            commands to run.
      type: object
      required:
      - commands
      title: ShellCallAction
      description: The shell commands and limits that describe how to run the tool
        call.
    ShellCallOutcomeExit:
      properties:
        exit_code:
          type: integer
          title: Exit Code
          description: Shell exit code.
        type:
          type: string
          const: exit
          title: Type
          description: Exit outcome.
      type: object
      required:
      - exit_code
      - type
      title: ShellCallOutcomeExit
      description: Indicates that the shell commands finished and returned an exit
        code.
    ShellCallOutcomeTimeout:
      properties:
        type:
          type: string
          const: timeout
          title: Type
          description: Timeout outcome.
      type: object
      required:
      - type
      title: ShellCallOutcomeTimeout
      description: Indicates that the shell call exceeded its configured time limit.
    ShellCallOutput:
      properties:
        call_id:
          type: string
          title: Call Id
          description: The unique ID of the shell tool call generated by the model.
        output:
          items:
            $ref: '#/components/schemas/ShellCallOutputContent'
          type: array
          title: Output
          description: Captured chunks of stdout and stderr output, along with their
            associated outcomes.
        type:
          type: string
          const: shell_call_output
          title: Type
          description: The type of the item. Always `shell_call_output`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of the shell tool call output. Populated when
            this item is returned via API.
        caller:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CallerDirect'
            - $ref: '#/components/schemas/CallerProgram'
            discriminator:
              propertyName: type
              mapping:
                direct: '#/components/schemas/CallerDirect'
                program: '#/components/schemas/CallerProgram'
          - type: 'null'
          title: Caller
          description: 'Provenance of this tool call: direct or programmatic.'
        max_output_length:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Output Length
          description: The maximum number of UTF-8 characters captured for this shell
            call's combined output.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the shell call output.
      type: object
      required:
      - call_id
      - output
      - type
      title: ShellCallOutput
      description: The streamed output items emitted by a shell tool call.
    ShellCallOutputContent:
      properties:
        outcome:
          oneOf:
          - $ref: '#/components/schemas/ShellCallOutcomeTimeout'
          - $ref: '#/components/schemas/ShellCallOutcomeExit'
          title: Outcome
          description: Exit or timeout outcome.
          discriminator:
            propertyName: type
            mapping:
              exit: '#/components/schemas/ShellCallOutcomeExit'
              timeout: '#/components/schemas/ShellCallOutcomeTimeout'
        stderr:
          type: string
          title: Stderr
          description: Captured stderr.
        stdout:
          type: string
          title: Stdout
          description: Captured stdout.
      type: object
      required:
      - outcome
      - stderr
      - stdout
      title: ShellCallOutputContent
      description: Captured stdout and stderr for a portion of a shell tool call output.
    ShellToolCallOutputContent:
      properties:
        outcome:
          oneOf:
          - $ref: '#/components/schemas/ShellToolCallOutputOutcomeTimeout'
          - $ref: '#/components/schemas/ShellToolCallOutputOutcomeExit'
          title: Outcome
          description: Represents either an exit outcome or a timeout outcome for
            a shell call output chunk.
          discriminator:
            propertyName: type
            mapping:
              exit: '#/components/schemas/ShellToolCallOutputOutcomeExit'
              timeout: '#/components/schemas/ShellToolCallOutputOutcomeTimeout'
        stderr:
          type: string
          title: Stderr
          description: The standard error output that was captured.
        stdout:
          type: string
          title: Stdout
          description: The standard output that was captured.
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: The identifier of the actor that created the item.
      additionalProperties: false
      type: object
      required:
      - outcome
      - stderr
      - stdout
      title: ShellToolCallOutputContent
      description: The content of a shell tool call output that was emitted.
    ShellToolCallOutputOutcomeExit:
      properties:
        exit_code:
          type: integer
          title: Exit Code
          description: Exit code from the shell process.
        type:
          type: string
          const: exit
          title: Type
          description: The outcome type. Always `exit`.
      additionalProperties: false
      type: object
      required:
      - exit_code
      - type
      title: ShellToolCallOutputOutcomeExit
      description: Indicates that the shell commands finished and returned an exit
        code.
    ShellToolCallOutputOutcomeTimeout:
      properties:
        type:
          type: string
          const: timeout
          title: Type
          description: Timeout outcome.
      additionalProperties: false
      type: object
      required:
      - type
      title: ShellToolCallOutputOutcomeTimeout
      description: Indicates that the shell call exceeded its configured time limit.
    ShowRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name to show.
          default: ''
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Deprecated alias of `model`.
          deprecated: true
        verbose:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Verbose
          description: Include the large verbose fields in the response.
      type: object
      title: ShowRequest
      description: Show model information request.
    ShowResponse:
      properties:
        license:
          anyOf:
          - type: string
          - type: 'null'
          title: License
          description: License of the model.
        modelfile:
          anyOf:
          - type: string
          - type: 'null'
          title: Modelfile
          description: Modelfile the model was built from.
        parameters:
          anyOf:
          - type: string
          - type: 'null'
          title: Parameters
          description: Model parameter settings.
        template:
          anyOf:
          - type: string
          - type: 'null'
          title: Template
          description: Prompt template of the model.
        system:
          anyOf:
          - type: string
          - type: 'null'
          title: System
          description: System prompt of the model.
        details:
          $ref: '#/components/schemas/ModelDetailsSummary'
          description: Origin of the model's weights.
        model_info:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Model Info
          description: Additional model metadata.
        capabilities:
          items:
            type: string
          type: array
          title: Capabilities
          description: Features the model supports.
        modified_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Modified At
          description: Last modified timestamp, ISO 8601.
      additionalProperties: false
      type: object
      required:
      - details
      title: ShowResponse
      description: 'Model information response.


        The five fields describing a local model file are omitted rather than

        reported empty, which is what Ollama Cloud does for a cloud-hosted model.'
    SkillParams:
      properties:
        skill_id:
          type: string
          title: Skill Id
          description: Identifier of the skill to load.
        type:
          type: string
          enum:
          - anthropic
          - custom
          title: Type
          description: 'Skill origin: built-in, or one you published.'
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
          description: Skill version, or `latest` for the most recent one.
      type: object
      required:
      - skill_id
      - type
      title: SkillParams
      description: 'A skill to load in the container.


        UNSUPPORTED on this implementation: accepted and ignored, and the rest of
        the

        request is served normally. The skill is never loaded, so its instructions

        never reach the model.'
    SkillReference:
      properties:
        skill_id:
          type: string
          title: Skill Id
          description: The ID of the referenced skill.
        type:
          type: string
          const: skill_reference
          title: Type
          description: References a skill created with the /v1/skills endpoint.
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
          description: Optional skill version. Use a positive integer or 'latest'.
            Omit for default.
      type: object
      required:
      - skill_id
      - type
      title: SkillReference
      description: References a skill created with the /v1/skills endpoint.
    SpeechCreateParams:
      properties:
        input:
          type: string
          minLength: 1
          title: Input
          description: Text to generate audio for. Models that support SSML also accept
            an SSML document.
        model:
          type: string
          maxLength: 255
          title: Model
          description: 'TTS model. Available: `amazon.polly-standard`, `amazon.polly-neural`,
            `amazon.polly-long-form`, `amazon.polly-generative`. Wildcard patterns
            are not selectable here: none of these models carries a release date,
            so a pattern never matches; name one of the models above.'
          default: amazon.polly-standard
        voice:
          type: string
          maxLength: 255
          minLength: 1
          title: Voice
          description: Voice for audio generation. Supported voices vary by model
            and language.
          default: alloy
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
          description: Additional voice control instructions. Does not work with `amazon.polly-standard`,
            `amazon.polly-neural`, `amazon.polly-long-form`, or `amazon.polly-generative`.
        response_format:
          type: string
          enum:
          - mp3
          - ogg
          - opus
          - aac
          - flac
          - wav
          - pcm
          title: Response Format
          description: 'Audio format: `mp3`, `opus`, `ogg`, `aac`, `flac`, `wav`,
            or `pcm`.'
          default: mp3
        speed:
          type: number
          maximum: 4.0
          minimum: 0.2
          title: Speed
          description: 'Audio speed. Range: `0.2` to `4.0`. Default: `1.0`. `amazon.polly-generative`
            speaks no faster than `2.0`, whatever higher value is set.'
          default: 1.0
        stream_format:
          type: string
          enum:
          - audio
          - sse
          title: Stream Format
          description: 'Streaming format: `sse` or `audio`. MCP tools default to `sse`
            for better client compatibility.'
          default: audio
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - input
      title: SpeechCreateParams
      description: Request model for text-to-speech generation.
    StaticChunkingConfig:
      properties:
        max_chunk_size_tokens:
          type: integer
          maximum: 4096.0
          minimum: 100.0
          title: Max Chunk Size Tokens
          description: Maximum number of tokens in each chunk (100 to 4096).
          default: 800
        chunk_overlap_tokens:
          type: integer
          minimum: 0.0
          title: Chunk Overlap Tokens
          description: Number of tokens shared between consecutive chunks; must not
            exceed half of `max_chunk_size_tokens`.
          default: 400
      type: object
      title: StaticChunkingConfig
      description: Chunk size and overlap, in tokens.
    StaticChunkingStrategy:
      properties:
        type:
          type: string
          const: static
          title: Type
          description: Always `static`.
          default: static
        static:
          $ref: '#/components/schemas/StaticChunkingConfig'
          description: Chunk size and overlap.
      additionalProperties: false
      type: object
      required:
      - static
      title: StaticChunkingStrategy
      description: The chunk size and overlap a file was indexed with.
    StaticChunkingStrategyParam:
      properties:
        type:
          type: string
          const: static
          title: Type
          description: Selects an explicit chunk size.
        static:
          $ref: '#/components/schemas/StaticChunkingConfig'
          description: Chunk size and overlap.
      type: object
      required:
      - type
      - static
      title: StaticChunkingStrategyParam
      description: Chunking strategy with a caller-chosen chunk size and overlap.
    StatusResponse:
      properties:
        status:
          type: string
          title: Status
          description: Status message.
      additionalProperties: false
      type: object
      required:
      - status
      title: StatusResponse
      description: Single-status response of a model management operation.
    StreamOptions:
      properties:
        include_obfuscation:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Include Obfuscation
          description: When true, stream obfuscation will be enabled. Adds random
            characters to normalize payload sizes as a mitigation to side-channel
            attacks.
      type: object
      title: StreamOptions
      description: 'Options for streaming responses. Only set this when you set `stream:
        true`.'
    TextBlock:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content block type.
        text:
          type: string
          title: Text
          description: Text content.
        citations:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/CitationCharLocation'
              - $ref: '#/components/schemas/CitationPageLocation'
              - $ref: '#/components/schemas/CitationContentBlockLocation'
              - $ref: '#/components/schemas/CitationsWebSearchResultLocation'
              - $ref: '#/components/schemas/CitationsSearchResultLocation'
              discriminator:
                propertyName: type
                mapping:
                  char_location: '#/components/schemas/CitationCharLocation'
                  content_block_location: '#/components/schemas/CitationContentBlockLocation'
                  page_location: '#/components/schemas/CitationPageLocation'
                  search_result_location: '#/components/schemas/CitationsSearchResultLocation'
                  web_search_result_location: '#/components/schemas/CitationsWebSearchResultLocation'
            type: array
          - type: 'null'
          title: Citations
          description: Citations supporting the text block.
      additionalProperties: false
      type: object
      required:
      - type
      - text
      title: TextBlock
      description: Text content block.
    TextBlockParam:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content block type.
        text:
          type: string
          title: Text
          description: Text content.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        citations:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/CitationCharLocationParam'
              - $ref: '#/components/schemas/CitationPageLocationParam'
              - $ref: '#/components/schemas/CitationContentBlockLocationParam'
              - $ref: '#/components/schemas/CitationWebSearchResultLocationParam'
              - $ref: '#/components/schemas/CitationSearchResultLocationParam'
              discriminator:
                propertyName: type
                mapping:
                  char_location: '#/components/schemas/CitationCharLocationParam'
                  content_block_location: '#/components/schemas/CitationContentBlockLocationParam'
                  page_location: '#/components/schemas/CitationPageLocationParam'
                  search_result_location: '#/components/schemas/CitationSearchResultLocationParam'
                  web_search_result_location: '#/components/schemas/CitationWebSearchResultLocationParam'
            type: array
          - type: 'null'
          title: Citations
          description: 'Citations supporting the text block. Type depends on document:
            PDF uses `page_location`, plain text uses `char_location`, content documents
            use `content_block_location`.'
      type: object
      required:
      - type
      - text
      title: TextBlockParam
      description: Text content block parameter for system prompts and messages.
    TextEditorCodeExecutionCreateResultBlock:
      properties:
        is_file_update:
          type: boolean
          title: Is File Update
          description: Whether this result is a file update.
        type:
          type: string
          const: text_editor_code_execution_create_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - is_file_update
      - type
      title: TextEditorCodeExecutionCreateResultBlock
      description: Text editor code execution create result block.
    TextEditorCodeExecutionCreateResultBlockParam:
      properties:
        is_file_update:
          type: boolean
          title: Is File Update
          description: Whether this result is a file update.
        type:
          type: string
          const: text_editor_code_execution_create_result
          title: Type
          description: Type discriminator.
      type: object
      required:
      - is_file_update
      - type
      title: TextEditorCodeExecutionCreateResultBlockParam
      description: Text editor code execution create result block parameter.
    TextEditorCodeExecutionStrReplaceResultBlock:
      properties:
        lines:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Lines
          description: The lines of content.
        new_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: New Lines
          description: The number of lines in the new text.
        new_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: New Start
          description: The starting line of the new text.
        old_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Old Lines
          description: The number of lines in the original text.
        old_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Old Start
          description: The starting line of the original text.
        type:
          type: string
          const: text_editor_code_execution_str_replace_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - type
      title: TextEditorCodeExecutionStrReplaceResultBlock
      description: Text editor code execution str replace result block.
    TextEditorCodeExecutionStrReplaceResultBlockParam:
      properties:
        type:
          type: string
          const: text_editor_code_execution_str_replace_result
          title: Type
          description: Type discriminator.
        lines:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Lines
          description: The lines of content.
        new_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: New Lines
          description: The number of lines in the new text.
        new_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: New Start
          description: The starting line of the new text.
        old_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Old Lines
          description: The number of lines in the original text.
        old_start:
          anyOf:
          - type: integer
          - type: 'null'
          title: Old Start
          description: The starting line of the original text.
      type: object
      required:
      - type
      title: TextEditorCodeExecutionStrReplaceResultBlockParam
      description: Text editor code execution str replace result block parameter.
    TextEditorCodeExecutionToolResultBlock:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultError'
          - $ref: '#/components/schemas/TextEditorCodeExecutionViewResultBlock'
          - $ref: '#/components/schemas/TextEditorCodeExecutionCreateResultBlock'
          - $ref: '#/components/schemas/TextEditorCodeExecutionStrReplaceResultBlock'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: text_editor_code_execution_tool_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: TextEditorCodeExecutionToolResultBlock
      description: Text editor code execution tool result block.
    TextEditorCodeExecutionToolResultBlockParam:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultErrorParam'
          - $ref: '#/components/schemas/TextEditorCodeExecutionViewResultBlockParam'
          - $ref: '#/components/schemas/TextEditorCodeExecutionCreateResultBlockParam'
          - $ref: '#/components/schemas/TextEditorCodeExecutionStrReplaceResultBlockParam'
          title: Content
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: text_editor_code_execution_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: TextEditorCodeExecutionToolResultBlockParam
      description: Text editor code execution tool result block parameter.
    TextEditorCodeExecutionToolResultError:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - too_many_requests
          - execution_time_exceeded
          - file_not_found
          title: Error Code
          description: Error code.
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message.
        type:
          type: string
          const: text_editor_code_execution_tool_result_error
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: TextEditorCodeExecutionToolResultError
      description: Text editor code execution tool result error.
    TextEditorCodeExecutionToolResultErrorParam:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - too_many_requests
          - execution_time_exceeded
          - file_not_found
          title: Error Code
          description: Error code.
        type:
          type: string
          const: text_editor_code_execution_tool_result_error
          title: Type
          description: Type discriminator.
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message.
      type: object
      required:
      - error_code
      - type
      title: TextEditorCodeExecutionToolResultErrorParam
      description: Text editor code execution tool result error parameter.
    TextEditorCodeExecutionViewResultBlock:
      properties:
        content:
          type: string
          title: Content
          description: Block content.
        file_type:
          type: string
          enum:
          - text
          - image
          - pdf
          title: File Type
          description: The type of file output.
        num_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Lines
          description: The number of lines.
        start_line:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start Line
          description: The starting line number.
        total_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Lines
          description: Total number of lines in the file.
        type:
          type: string
          const: text_editor_code_execution_view_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - file_type
      - type
      title: TextEditorCodeExecutionViewResultBlock
      description: Text editor code execution view result block.
    TextEditorCodeExecutionViewResultBlockParam:
      properties:
        content:
          type: string
          title: Content
          description: Block content.
        file_type:
          type: string
          enum:
          - text
          - image
          - pdf
          title: File Type
          description: The type of file output.
        type:
          type: string
          const: text_editor_code_execution_view_result
          title: Type
          description: Type discriminator.
        num_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Lines
          description: The number of lines.
        start_line:
          anyOf:
          - type: integer
          - type: 'null'
          title: Start Line
          description: The starting line number.
        total_lines:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Lines
          description: Total number of lines in the file.
      type: object
      required:
      - content
      - file_type
      - type
      title: TextEditorCodeExecutionViewResultBlockParam
      description: Text editor code execution view result block parameter.
    ThinkingBlock:
      properties:
        type:
          type: string
          const: thinking
          title: Type
          description: Content block type. Always `thinking`.
        thinking:
          type: string
          title: Thinking
          description: The thinking process content.
        signature:
          anyOf:
          - type: string
          - type: 'null'
          title: Signature
          description: Signature for the thinking block.
      additionalProperties: false
      type: object
      required:
      - type
      - thinking
      title: ThinkingBlock
      description: Thinking content block for extended thinking.
    ThinkingBlockParam:
      properties:
        type:
          type: string
          const: thinking
          title: Type
          description: Content block type. Always `thinking`.
        thinking:
          type: string
          title: Thinking
          description: The thinking process content.
        signature:
          anyOf:
          - type: string
          - type: 'null'
          title: Signature
          description: A token that verifies that the thinking text was generated
            by the model.
      type: object
      required:
      - type
      - thinking
      title: ThinkingBlockParam
      description: Thinking content block parameter.
    ThinkingConfigAdaptiveParam:
      properties:
        type:
          type: string
          const: adaptive
          title: Type
          description: Thinking config type. Always `adaptive`.
        display:
          anyOf:
          - type: string
            enum:
            - summarized
            - omitted
          - type: 'null'
          title: Display
          description: '`summarized` returns a summary of the thinking; `omitted`
            returns thinking blocks with an empty `thinking` field and their signature.
            The default depends on the model: recent models omit it. Billing is the
            same either way.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - type
      title: ThinkingConfigAdaptiveParam
      description: Adaptive thinking configuration.
    ThinkingConfigBetweenToolsParam:
      properties:
        type:
          type: string
          const: between_tools
          title: Type
          description: 'Thinking config type. Always `between_tools`: no thinking
            before the answer, only short progress updates between tool calls. The
            lowest setting of models that cannot disable thinking; others get it disabled.'
      type: object
      required:
      - type
      title: ThinkingConfigBetweenToolsParam
      description: 'Between-tools thinking configuration: no up-front thinking.'
    ThinkingConfigDisabledParam:
      properties:
        type:
          type: string
          const: disabled
          title: Type
          description: Thinking config type. Always `disabled`.
      type: object
      required:
      - type
      title: ThinkingConfigDisabledParam
      description: Disabled thinking configuration.
    ThinkingConfigEnabledParam:
      properties:
        type:
          type: string
          const: enabled
          title: Type
          description: Thinking config type. Always `enabled`.
        budget_tokens:
          type: integer
          title: Budget Tokens
          description: Determines how many tokens the model can use for its internal
            reasoning process. Larger budgets can enable more thorough analysis for
            complex problems, improving response quality. Must be less than `max_tokens`.
        display:
          anyOf:
          - type: string
            enum:
            - summarized
            - omitted
          - type: 'null'
          title: Display
          description: '`summarized` returns a summary of the thinking; `omitted`
            returns thinking blocks with an empty `thinking` field and their signature.
            The default depends on the model: recent models omit it. Billing is the
            same either way.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - type
      - budget_tokens
      title: ThinkingConfigEnabledParam
      description: Enabled thinking configuration.
    ThinkingTurnsParam:
      properties:
        type:
          type: string
          const: thinking_turns
          title: Type
          description: Keep type.
        value:
          type: integer
          minimum: 1.0
          title: Value
          description: Most recent thinking turns to keep.
      type: object
      required:
      - type
      - value
      title: ThinkingTurnsParam
      description: Number of most recent assistant turns whose thinking is kept.
    ToolBashParam:
      properties:
        type:
          type: string
          pattern: ^bash(?:_[0-9]{8})?$
          title: Type
          description: Tool type.
        name:
          type: string
          const: bash
          title: Name
          description: Tool name used in tool_use blocks.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        input_examples:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Input Examples
          description: Example inputs.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - type
      - name
      title: ToolBashParam
      description: Bash tool definition for command execution.
    ToolCall:
      properties:
        function:
          $ref: '#/components/schemas/ToolCallFunction'
          description: Function call details.
      additionalProperties: false
      type: object
      required:
      - function
      title: ToolCall
      description: Tool call requested by the model.
    ToolCallFunction:
      properties:
        name:
          type: string
          title: Name
          description: Name of the function to call.
        arguments:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Arguments
          description: JSON object of arguments to pass.
        index:
          anyOf:
          - type: integer
          - type: 'null'
          title: Index
          description: Position of the call in the tool call list.
      additionalProperties: false
      type: object
      required:
      - name
      title: ToolCallFunction
      description: Function a tool call invokes.
    ToolChoiceAllowed:
      properties:
        mode:
          type: string
          enum:
          - auto
          - required
          title: Mode
          description: '`auto` lets model pick tools. `required` forces tool call.'
        tools:
          items:
            additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          type: array
          title: Tools
          description: Allowed tool definitions.
        type:
          type: string
          const: allowed_tools
          title: Type
          description: Allowed tools type.
      type: object
      required:
      - mode
      - tools
      - type
      title: ToolChoiceAllowed
      description: Constrains the tools available to the model to a pre-defined set.
    ToolChoiceAnyParam:
      properties:
        type:
          type: string
          const: any
          title: Type
          description: Tool choice type. Always `any`.
        disable_parallel_tool_use:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Disable Parallel Tool Use
          description: Disable parallel tool use.
      type: object
      required:
      - type
      title: ToolChoiceAnyParam
      description: Any tool choice - model must use at least one tool.
    ToolChoiceApplyPatch:
      properties:
        type:
          type: string
          const: apply_patch
          title: Type
          description: Apply patch tool.
      type: object
      required:
      - type
      title: ToolChoiceApplyPatch
      description: Forces the model to call the apply_patch tool when executing a
        tool call.
    ToolChoiceAutoParam:
      properties:
        type:
          type: string
          const: auto
          title: Type
          description: Tool choice type. Always `auto`.
        disable_parallel_tool_use:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Disable Parallel Tool Use
          description: Disable parallel tool use.
      type: object
      required:
      - type
      title: ToolChoiceAutoParam
      description: Auto tool choice - model decides whether to use tools.
    ToolChoiceCustom:
      properties:
        name:
          type: string
          title: Name
          description: Custom tool name to call.
        type:
          type: string
          const: custom
          title: Type
          description: Custom tool type.
      type: object
      required:
      - name
      - type
      title: ToolChoiceCustom
      description: Force the model to call a specific custom tool.
    ToolChoiceFunction:
      properties:
        name:
          type: string
          title: Name
          description: Function name to call.
        type:
          type: string
          const: function
          title: Type
          description: Function tool type.
      type: object
      required:
      - name
      - type
      title: ToolChoiceFunction
      description: Force the model to call a specific function.
    ToolChoiceMcp:
      properties:
        server_label:
          type: string
          title: Server Label
          description: MCP server label.
        type:
          type: string
          const: mcp
          title: Type
          description: MCP tool type.
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Tool name on the server.
      type: object
      required:
      - server_label
      - type
      title: ToolChoiceMcp
      description: Force the model to call a specific tool on a remote MCP server.
    ToolChoiceNoneParam:
      properties:
        type:
          type: string
          const: none
          title: Type
          description: Type discriminator.
      type: object
      required:
      - type
      title: ToolChoiceNoneParam
      description: The model will not be allowed to use tools.
    ToolChoiceProgrammaticToolCalling:
      properties:
        type:
          type: string
          const: programmatic_tool_calling
          title: Type
          description: Programmatic tool calling.
      type: object
      required:
      - type
      title: ToolChoiceProgrammaticToolCalling
      description: 'Forces the model to use programmatic tool calling.


        Honored only by models that support programmatic tool calling;

        accepted and ignored on all others (the default tool choice applies).'
    ToolChoiceShell:
      properties:
        type:
          type: string
          const: shell
          title: Type
          description: Shell tool.
      type: object
      required:
      - type
      title: ToolChoiceShell
      description: Forces the model to call the shell tool when a tool call is required.
    ToolChoiceToolParam:
      properties:
        type:
          type: string
          const: tool
          title: Type
          description: Tool choice type. Always `tool`.
        name:
          type: string
          title: Name
          description: Name of the tool to use.
        disable_parallel_tool_use:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Disable Parallel Tool Use
          description: Disable parallel tool use.
      type: object
      required:
      - type
      - name
      title: ToolChoiceToolParam
      description: Specific tool choice - model must use the specified tool.
    ToolChoiceTypes:
      properties:
        type:
          type: string
          enum:
          - file_search
          - web_search_preview
          - computer
          - computer_use_preview
          - computer_use
          - web_search_preview_2025_03_11
          - image_generation
          - code_interpreter
          title: Type
          description: Built-in tool type to use.
      type: object
      required:
      - type
      title: ToolChoiceTypes
      description: Indicates that the model should use a built-in tool to generate
        a response.
    ToolComputerParam:
      properties:
        type:
          type: string
          pattern: ^computer(?:_[0-9]{8})?$
          title: Type
          description: Tool type. Always ``computer_*``.
        name:
          type: string
          const: computer
          title: Name
          description: Name of the tool.  This is how the tool will be called by the
            model and in ``tool_use`` blocks.
        display_width_px:
          type: integer
          title: Display Width Px
          description: The width of the display in pixels.
        display_height_px:
          type: integer
          title: Display Height Px
          description: The height of the display in pixels.
        display_number:
          anyOf:
          - type: integer
          - type: 'null'
          title: Display Number
          description: The X11 display number (e.g. 0, 1) for the display.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        enable_zoom:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enable Zoom
          description: Whether to enable an action to take a zoomed-in screenshot
            of the screen.  Added in ``computer_20251124``.
        input_examples:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Input Examples
          description: Example inputs.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - type
      - name
      - display_width_px
      - display_height_px
      title: ToolComputerParam
      description: Computer use tool definition for GUI automation.
    ToolDefinition:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: Tool type. Always `function`.
        function:
          $ref: '#/components/schemas/ToolFunction'
          description: Function exposed to the model.
      type: object
      required:
      - type
      - function
      title: ToolDefinition
      description: Function tool the model may call.
    ToolFunction:
      properties:
        name:
          type: string
          title: Name
          description: Function name exposed to the model.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: What the function does.
        parameters:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Parameters
          description: JSON Schema for the function parameters.
      type: object
      required:
      - name
      title: ToolFunction
      description: Function a tool exposes to the model.
    ToolInputSchema:
      properties:
        type:
          type: string
          const: object
          title: Type
          description: Schema type.
          default: object
        properties:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Properties
          description: Schema properties.
        required:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Required
          description: Required properties.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      title: ToolInputSchema
      description: 'JSON schema for tool input parameters.


        Arbitrary additional JSON Schema keywords (``$schema``, ``$defs``,

        ``additionalProperties``, ...) are accepted and forwarded upstream.'
    ToolParam:
      properties:
        type:
          type: string
          const: custom
          title: Type
          description: Tool type.
          default: custom
        name:
          type: string
          title: Name
          description: Name of the tool, used to call it in `tool_use` blocks.
        input_schema:
          $ref: '#/components/schemas/ToolInputSchema'
          description: JSON schema for the shape of the `input` this tool accepts
            and that the model will produce.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description of what this tool does. More detail helps the model
            use it correctly.
        eager_input_streaming:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Eager Input Streaming
          description: Stream tool input parameters incrementally as they are generated
            instead of buffering the full JSON output. When null (default), behavior
            follows the fine-grained-tool-streaming beta header.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        input_examples:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Input Examples
          description: Example inputs.
      type: object
      required:
      - name
      - input_schema
      title: ToolParam
      description: Tool definition for function calling.
    ToolReferenceBlock:
      properties:
        tool_name:
          type: string
          title: Tool Name
          description: Tool name.
        type:
          type: string
          const: tool_reference
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - tool_name
      - type
      title: ToolReferenceBlock
      description: Tool reference block.
    ToolReferenceBlockParam:
      properties:
        tool_name:
          type: string
          title: Tool Name
          description: Tool name.
        type:
          type: string
          const: tool_reference
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - tool_name
      - type
      title: ToolReferenceBlockParam
      description: Tool reference block that can be included in tool_result content.
    ToolResultBlockParam:
      properties:
        type:
          type: string
          const: tool_result
          title: Type
          description: Content block type. Always `tool_result`.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: ID of the tool use this result corresponds to.
        content:
          anyOf:
          - type: string
          - items:
              oneOf:
              - $ref: '#/components/schemas/TextBlockParam'
              - $ref: '#/components/schemas/ImageBlockParam'
              - $ref: '#/components/schemas/DocumentBlockParam'
              - $ref: '#/components/schemas/SearchResultBlockParam'
              - $ref: '#/components/schemas/ToolReferenceBlockParam'
              - $ref: '#/components/schemas/BrowserStateBlockParam'
              discriminator:
                propertyName: type
                mapping:
                  browser_state: '#/components/schemas/BrowserStateBlockParam'
                  document: '#/components/schemas/DocumentBlockParam'
                  image: '#/components/schemas/ImageBlockParam'
                  search_result: '#/components/schemas/SearchResultBlockParam'
                  text: '#/components/schemas/TextBlockParam'
                  tool_reference: '#/components/schemas/ToolReferenceBlockParam'
            type: array
          - type: 'null'
          title: Content
          description: What the tool returned. Omit it, or leave it empty, for a tool
            that returns nothing.
        is_error:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Error
          description: Whether this is an error result.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        toolset_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Toolset Name
          description: For a result answering a member of a tool family declared as
            a toolset, the `tools` entry type of that family.
      type: object
      required:
      - type
      - tool_use_id
      title: ToolResultBlockParam
      description: Tool result content block parameter.
    ToolSearchCallInput:
      properties:
        arguments:
          title: Arguments
          description: The arguments supplied to the tool search call.
        type:
          type: string
          const: tool_search_call
          title: Type
          description: The item type. Always `tool_search_call`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of this tool search call.
        call_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Call Id
          description: The unique ID of the tool search call generated by the model.
        execution:
          anyOf:
          - type: string
            enum:
            - server
            - client
          - type: 'null'
          title: Execution
          description: Whether tool search was executed by the server or by the client.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the tool search call.
      type: object
      required:
      - arguments
      - type
      title: ToolSearchCallInput
      description: A tool search call input item.
    ToolSearchOutputInput:
      properties:
        tools:
          items:
            additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          type: array
          title: Tools
          description: The loaded tool definitions returned by the tool search output.
        type:
          type: string
          const: tool_search_output
          title: Type
          description: The item type. Always `tool_search_output`.
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
          description: The unique ID of this tool search output.
        call_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Call Id
          description: The unique ID of the tool search call generated by the model.
        execution:
          anyOf:
          - type: string
            enum:
            - server
            - client
          - type: 'null'
          title: Execution
          description: Whether tool search was executed by the server or by the client.
        status:
          anyOf:
          - type: string
            enum:
            - in_progress
            - completed
            - incomplete
          - type: 'null'
          title: Status
          description: The status of the tool search output.
      type: object
      required:
      - tools
      - type
      title: ToolSearchOutputInput
      description: The loaded tool definitions returned by a tool search call (as
        input item).
    ToolSearchTool:
      properties:
        type:
          type: string
          const: tool_search
          title: Type
          description: Tool search type.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Description for client-executed tool search.
        execution:
          anyOf:
          - type: string
            enum:
            - server
            - client
          - type: 'null'
          title: Execution
          description: Execute tool search on server or client.
        parameters:
          anyOf:
          - {}
          - type: 'null'
          title: Parameters
          description: Parameter schema for client-executed tool search.
      type: object
      required:
      - type
      title: ToolSearchTool
      description: 'Hosted or BYOT tool search configuration for deferred tools.


        UNSUPPORTED on this implementation.'
    ToolSearchToolBm25Param:
      properties:
        name:
          type: string
          const: tool_search_tool_bm25
          title: Name
          description: Tool name.
        type:
          type: string
          pattern: ^tool_search_tool_bm25(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - name
      - type
      title: ToolSearchToolBm25Param
      description: Tool search tool BM25 parameter.
    ToolSearchToolRegexParam:
      properties:
        name:
          type: string
          const: tool_search_tool_regex
          title: Name
          description: Tool name.
        type:
          type: string
          pattern: ^tool_search_tool_regex(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - name
      - type
      title: ToolSearchToolRegexParam
      description: Tool search tool regex parameter.
    ToolSearchToolResultBlock:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/ToolSearchToolResultError'
          - $ref: '#/components/schemas/ToolSearchToolSearchResultBlock'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: tool_search_tool_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: ToolSearchToolResultBlock
      description: Tool search tool result block.
    ToolSearchToolResultBlockParam:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/ToolSearchToolResultErrorParam'
          - $ref: '#/components/schemas/ToolSearchToolSearchResultBlockParam'
          title: Content
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: tool_search_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: ToolSearchToolResultBlockParam
      description: Tool search tool result block parameter.
    ToolSearchToolResultError:
      properties:
        error_code:
          $ref: '#/components/schemas/ToolSearchToolResultErrorCode'
          description: Error code.
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message.
        type:
          type: string
          const: tool_search_tool_result_error
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: ToolSearchToolResultError
      description: Tool search tool result error.
    ToolSearchToolResultErrorCode:
      type: string
      enum:
      - invalid_tool_input
      - unavailable
      - too_many_requests
      - execution_time_exceeded
    ToolSearchToolResultErrorParam:
      properties:
        error_code:
          $ref: '#/components/schemas/ToolSearchToolResultErrorCode'
          description: Error code.
        type:
          type: string
          const: tool_search_tool_result_error
          title: Type
          description: Type discriminator.
      type: object
      required:
      - error_code
      - type
      title: ToolSearchToolResultErrorParam
      description: Tool search tool result error parameter.
    ToolSearchToolSearchResultBlock:
      properties:
        tool_references:
          items:
            $ref: '#/components/schemas/ToolReferenceBlock'
          type: array
          title: Tool References
          description: Tool references.
        type:
          type: string
          const: tool_search_tool_search_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - tool_references
      - type
      title: ToolSearchToolSearchResultBlock
      description: Tool search tool search result block.
    ToolSearchToolSearchResultBlockParam:
      properties:
        tool_references:
          items:
            $ref: '#/components/schemas/ToolReferenceBlockParam'
          type: array
          title: Tool References
          description: Tool references.
        type:
          type: string
          const: tool_search_tool_search_result
          title: Type
          description: Type discriminator.
      type: object
      required:
      - tool_references
      - type
      title: ToolSearchToolSearchResultBlockParam
      description: Tool search tool search result block parameter.
    ToolTextEditorParam:
      properties:
        type:
          type: string
          pattern: ^text_editor(?:_[0-9]{8})?$
          title: Type
          description: Tool type.
        name:
          type: string
          enum:
          - str_replace_editor
          - str_replace_based_edit_tool
          title: Name
          description: Tool name used in tool_use blocks.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        input_examples:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Input Examples
          description: Example inputs.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
        max_characters:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Characters
          description: Maximum number of characters to display when viewing a file.  If
            not specified, defaults to displaying the full file.
      type: object
      required:
      - type
      - name
      title: ToolTextEditorParam
      description: Text editor tool definition for file editing.
    ToolUseBlock:
      properties:
        type:
          type: string
          const: tool_use
          title: Type
          description: Content block type. Always `tool_use`.
        id:
          type: string
          title: Id
          description: Unique identifier for this tool use.
        name:
          type: string
          title: Name
          description: Name of the tool being used.
        input:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Input
          description: Tool input parameters as a JSON object.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
        toolset_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Toolset Name
          description: For a member of a tool family declared as a toolset, the `tools`
            entry type of that family. Send it back on the matching `tool_result`.
      additionalProperties: false
      type: object
      required:
      - type
      - id
      - name
      - input
      title: ToolUseBlock
      description: Tool use content block.
    ToolUseBlockParam:
      properties:
        type:
          type: string
          const: tool_use
          title: Type
          description: Content block type. Always `tool_use`.
        id:
          type: string
          title: Id
          description: Unique identifier for this tool use.
        name:
          type: string
          title: Name
          description: Name of the tool being used.
        input:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Input
          description: Tool input parameters as a JSON object.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control for this content block.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
        toolset_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Toolset Name
          description: For a member of a tool family declared as a toolset, the `tools`
            entry type of that family.
      type: object
      required:
      - type
      - id
      - name
      - input
      title: ToolUseBlockParam
      description: Tool use content block parameter.
    ToolUsesKeepParam:
      properties:
        type:
          type: string
          const: tool_uses
          title: Type
          description: Keep type.
        value:
          type: integer
          minimum: 0.0
          title: Value
          description: Most recent tool uses to keep.
      type: object
      required:
      - type
      - value
      title: ToolUsesKeepParam
      description: Number of most recent tool uses kept by a context edit.
    ToolUsesTriggerParam:
      properties:
        type:
          type: string
          const: tool_uses
          title: Type
          description: Trigger type.
        value:
          type: integer
          minimum: 1.0
          title: Value
          description: Tool uses that trigger the edit.
      type: object
      required:
      - type
      - value
      title: ToolUsesTriggerParam
      description: Context editing trigger on the number of tool uses.
    ToolsetMemberConfigParam:
      properties:
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Load the tool only when it is referenced.
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          description: Whether the tool is offered to the model.
      type: object
      title: ToolsetMemberConfigParam
      description: Configuration of one member tool of a toolset.
    TopLogprob:
      properties:
        token:
          type: string
          title: Token
          description: The token.
        bytes:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Bytes
          description: UTF-8 byte representation of the token. Can be null if unavailable.
        logprob:
          type: number
          title: Logprob
          description: Log probability if in top 20 tokens, otherwise -9999.0.
      additionalProperties: false
      type: object
      required:
      - token
      - logprob
      title: TopLogprob
      description: Top log probability token information.
    TranscriptionSessionConfig:
      properties:
        type:
          type: string
          const: transcription
          title: Type
          description: Kind of session to open.
          default: transcription
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Model serving the session.
        audio:
          $ref: '#/components/schemas/AudioConfig'
          description: Input and output audio settings.
        include:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Include
          description: 'UNSUPPORTED: no extra output fields are available.'
      type: object
      title: TranscriptionSessionConfig
      description: Configuration of a transcription-only Realtime session.
    TurnDetection:
      properties:
        type:
          type: string
          enum:
          - server_vad
          - semantic_vad
          title: Type
          description: Turn detection mode.
          default: server_vad
        create_response:
          type: boolean
          title: Create Response
          description: 'UNSUPPORTED: a detected end of speech always starts a response;
            send audio without turn detection to transcribe without answering.'
          default: true
        interrupt_response:
          type: boolean
          title: Interrupt Response
          description: 'UNSUPPORTED: whether new speech interrupts a response in progress
            is decided by the model.'
          default: true
        threshold:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Threshold
          description: 'UNSUPPORTED: the detection sensitivity is not adjustable.'
        prefix_padding_ms:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Prefix Padding Ms
          description: 'UNSUPPORTED: audio kept before detected speech is fixed.'
        silence_duration_ms:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Silence Duration Ms
          description: 'UNSUPPORTED: the silence ending a turn is not adjustable.'
        idle_timeout_ms:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Idle Timeout Ms
          description: 'UNSUPPORTED: no response is started on an idle caller.'
        eagerness:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
            - auto
          - type: 'null'
          title: Eagerness
          description: 'UNSUPPORTED: semantic eagerness is not adjustable.'
      type: object
      title: TurnDetection
      description: Voice activity detection ending the caller's turn.
    URLImageSource:
      properties:
        type:
          type: string
          const: url
          title: Type
          description: Image source type.
        url:
          type: string
          minLength: 1
          title: Url
          description: URL of the image, data URI, S3 URI, or base64 encoded string.
      type: object
      required:
      - type
      - url
      title: URLImageSource
      description: URL image source for image content block.
    URLPDFSource:
      properties:
        type:
          type: string
          const: url
          title: Type
          description: Document source type.
        url:
          type: string
          minLength: 1
          title: Url
          description: URL of the PDF document, data URI, S3 URI, or base64 encoded
            string.
      type: object
      required:
      - type
      - url
      title: URLPDFSource
      description: URL PDF source for document content block.
    Upload:
      properties:
        id:
          type: string
          pattern: ^upload_[a-z0-9]{32}$
          title: Id
          description: The Upload unique identifier.
        object:
          type: string
          const: upload
          title: Object
          description: The object type, which is always 'upload'.
          default: upload
        bytes:
          type: integer
          title: Bytes
          description: The intended number of bytes to be uploaded.
        created_at:
          type: integer
          title: Created At
          description: The Unix timestamp (in seconds) for when the Upload was created.
        expires_at:
          type: integer
          title: Expires At
          description: The Unix timestamp (in seconds) for when the Upload will expire.
        filename:
          type: string
          title: Filename
          description: The name of the file to be uploaded.
        purpose:
          type: string
          enum:
          - assistants
          - batch
          - fine-tune
          - vision
          - user_data
          - evals
          title: Purpose
          description: The intended purpose of the file.
        status:
          type: string
          enum:
          - pending
          - completed
          - cancelled
          - expired
          title: Status
          description: The status of the Upload.
        file:
          anyOf:
          - $ref: '#/components/schemas/FileObject'
          - type: 'null'
          description: The ready File object after the Upload is completed.
      additionalProperties: false
      type: object
      required:
      - id
      - bytes
      - created_at
      - expires_at
      - filename
      - purpose
      - status
      title: Upload
      description: The Upload object can accept byte chunks in the form of Parts.
    UploadExpiresAfter:
      properties:
        anchor:
          type: string
          const: created_at
          title: Anchor
          description: 'Anchor timestamp after which the expiration policy applies.
            Supported anchors: `created_at`.'
        seconds:
          type: integer
          maximum: 2592000.0
          minimum: 3600.0
          title: Seconds
          description: Seconds after the anchor time until the file expires (1 hour
            to 30 days).
      type: object
      required:
      - anchor
      - seconds
      title: UploadExpiresAfter
      description: Expiration policy applied to the file created by an upload.
    UploadPart:
      properties:
        id:
          type: string
          pattern: ^part_[0-9a-f]{32}$
          title: Id
          description: The upload Part unique identifier.
        object:
          type: string
          const: upload.part
          title: Object
          description: The object type, which is always `upload.part`.
          default: upload.part
        created_at:
          type: integer
          title: Created At
          description: The Unix timestamp (in seconds) for when the Part was created.
        upload_id:
          type: string
          pattern: ^upload_[a-z0-9]{32}$
          title: Upload Id
          description: The ID of the Upload object that this Part was added to.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - upload_id
      title: UploadPart
      description: A part of a multipart upload.
    UsageAmount:
      properties:
        value:
          anyOf:
          - type: number
          - type: 'null'
          title: Value
          description: The amount.
        currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Currency
          description: Lowercase ISO-4217 currency code of the amount.
      additionalProperties: false
      type: object
      title: UsageAmount
      description: Monetary amount of a costs result.
    UsageInputTokensDetails:
      properties:
        image_tokens:
          type: integer
          minimum: 0.0
          title: Image Tokens
          description: The number of image tokens in the input prompt.
          default: 0
        text_tokens:
          type: integer
          minimum: 0.0
          title: Text Tokens
          description: The number of text tokens in the input prompt.
          default: 0
      additionalProperties: false
      type: object
      title: UsageInputTokensDetails
      description: Detailed input token usage for image generation.
    UsagePage:
      properties:
        object:
          type: string
          const: page
          title: Object
          default: page
        data:
          items:
            $ref: '#/components/schemas/UsageTimeBucket'
          type: array
          title: Data
          description: The time buckets of this page.
        has_more:
          type: boolean
          title: Has More
          description: Whether a next page exists.
          default: false
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: Cursor to pass as `page` to read the next page.
      additionalProperties: false
      type: object
      title: UsagePage
      description: A page of time buckets.
    UsageTimeBucket:
      properties:
        object:
          type: string
          const: bucket
          title: Object
          default: bucket
        start_time:
          type: integer
          title: Start Time
          description: Start of the bucket, in Unix seconds.
        end_time:
          type: integer
          title: End Time
          description: End of the bucket, in Unix seconds.
        results:
          items:
            oneOf:
            - $ref: '#/components/schemas/CompletionsResult'
            - $ref: '#/components/schemas/EmbeddingsResult'
            - $ref: '#/components/schemas/ModerationsResult'
            - $ref: '#/components/schemas/ImagesResult'
            - $ref: '#/components/schemas/AudioSpeechesResult'
            - $ref: '#/components/schemas/AudioTranscriptionsResult'
            - $ref: '#/components/schemas/VectorStoresResult'
            - $ref: '#/components/schemas/CodeInterpreterSessionsResult'
            - $ref: '#/components/schemas/FileSearchesResult'
            - $ref: '#/components/schemas/WebSearchesResult'
            - $ref: '#/components/schemas/CostsResult'
            discriminator:
              propertyName: object
              mapping:
                organization.costs.result: '#/components/schemas/CostsResult'
                organization.usage.audio_speeches.result: '#/components/schemas/AudioSpeechesResult'
                organization.usage.audio_transcriptions.result: '#/components/schemas/AudioTranscriptionsResult'
                organization.usage.code_interpreter_sessions.result: '#/components/schemas/CodeInterpreterSessionsResult'
                organization.usage.completions.result: '#/components/schemas/CompletionsResult'
                organization.usage.embeddings.result: '#/components/schemas/EmbeddingsResult'
                organization.usage.file_searches.result: '#/components/schemas/FileSearchesResult'
                organization.usage.images.result: '#/components/schemas/ImagesResult'
                organization.usage.moderations.result: '#/components/schemas/ModerationsResult'
                organization.usage.vector_stores.result: '#/components/schemas/VectorStoresResult'
                organization.usage.web_searches.result: '#/components/schemas/WebSearchesResult'
          type: array
          title: Results
          description: Aggregated results of this bucket.
      additionalProperties: false
      type: object
      required:
      - start_time
      - end_time
      title: UsageTimeBucket
      description: One time bucket of a usage or costs page.
    UserLocationParam:
      properties:
        type:
          type: string
          const: approximate
          title: Type
          description: Type discriminator.
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: User city.
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: Two-letter ISO country code of the user.
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
          description: User region.
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          description: IANA timezone of the user.
      type: object
      required:
      - type
      title: UserLocationParam
      description: User location parameter.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    VectorStore:
      properties:
        id:
          type: string
          title: Id
          description: The vector store identifier.
        object:
          type: string
          const: vector_store
          title: Object
          description: The object type, always `vector_store`.
          default: vector_store
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (seconds) of creation.
        name:
          type: string
          title: Name
          description: The name of the vector store.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: The description of the vector store.
        usage_bytes:
          type: integer
          title: Usage Bytes
          description: Bytes of indexed content in the store.
        file_counts:
          $ref: '#/components/schemas/FileCounts'
          description: Per-status file counts.
        status:
          type: string
          enum:
          - expired
          - in_progress
          - completed
          title: Status
          description: '`completed` once every attached file finished processing.'
        expires_after:
          anyOf:
          - $ref: '#/components/schemas/ExpiresAfter'
          - type: 'null'
          description: The expiration policy, when one is set.
        expires_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires At
          description: Unix timestamp (seconds) the store expires at.
        last_active_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Last Active At
          description: Unix timestamp (seconds) of the last activity.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
              maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Metadata
          description: Caller-supplied key-value pairs.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - name
      - usage_bytes
      - file_counts
      - status
      title: VectorStore
      description: A searchable collection of indexed files.
    VectorStoreCreateParams:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 256
          - type: 'null'
          title: Name
          description: A name for the vector store.
        description:
          anyOf:
          - type: string
            maxLength: 512
          - type: 'null'
          title: Description
          description: A description of what the vector store holds.
        file_ids:
          anyOf:
          - items:
              type: string
              pattern: ^file[-_][a-z0-9]{32}$
            type: array
            maxItems: 2000
          - type: 'null'
          title: File Ids
          description: IDs of uploaded files to index into the new store. Indexing
            runs in the background; poll the store until its `status` is `completed`.
        chunking_strategy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/AutoChunkingStrategyParam'
            - $ref: '#/components/schemas/StaticChunkingStrategyParam'
            discriminator:
              propertyName: type
              mapping:
                auto: '#/components/schemas/AutoChunkingStrategyParam'
                static: '#/components/schemas/StaticChunkingStrategyParam'
          - type: 'null'
          title: Chunking Strategy
          description: How the files are split before indexing. Applies to `file_ids`
            and to every file later attached without its own strategy.
        expires_after:
          anyOf:
          - $ref: '#/components/schemas/ExpiresAfter'
          - type: 'null'
          description: Expire the store this many days after its last activity.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
              maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Metadata
          description: Up to 16 key-value pairs stored with the vector store. Keys
            are at most 64 characters and values at most 512 characters.
      type: object
      title: VectorStoreCreateParams
      description: Request body of `POST /v1/vector_stores`.
    VectorStoreDeleted:
      properties:
        id:
          type: string
          title: Id
          description: The vector store identifier.
        object:
          type: string
          const: vector_store.deleted
          title: Object
          description: The object type.
          default: vector_store.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Whether the vector store was deleted.
      additionalProperties: false
      type: object
      required:
      - id
      - deleted
      title: VectorStoreDeleted
      description: Confirmation that a vector store was deleted.
    VectorStoreFile:
      properties:
        id:
          type: string
          title: Id
          description: The file identifier.
        object:
          type: string
          const: vector_store.file
          title: Object
          description: The object type.
          default: vector_store.file
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (seconds) of the attachment.
        usage_bytes:
          type: integer
          title: Usage Bytes
          description: Bytes of indexed content for this file.
        vector_store_id:
          type: string
          title: Vector Store Id
          description: The vector store the file belongs to.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - cancelled
          - failed
          title: Status
          description: '`completed` once the file is searchable.'
        last_error:
          anyOf:
          - $ref: '#/components/schemas/LastError'
          - type: 'null'
          description: The failure that stopped processing, if any.
        chunking_strategy:
          anyOf:
          - $ref: '#/components/schemas/StaticChunkingStrategy'
          - type: 'null'
          description: The chunk size and overlap used for this file.
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: Caller-supplied key-value pairs.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - usage_bytes
      - vector_store_id
      - status
      title: VectorStoreFile
      description: A file attached to a vector store.
    VectorStoreFileBatch:
      properties:
        id:
          type: string
          title: Id
          description: The file batch identifier.
        object:
          type: string
          const: vector_store.file_batch
          title: Object
          description: The object type.
          default: vector_store.file_batch
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (seconds) of creation.
        vector_store_id:
          type: string
          title: Vector Store Id
          description: The vector store the batch belongs to.
        status:
          type: string
          enum:
          - in_progress
          - completed
          - cancelled
          - failed
          title: Status
          description: '`completed` once every file in the batch finished processing.'
        file_counts:
          $ref: '#/components/schemas/FileCounts'
          description: Per-status file counts.
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - vector_store_id
      - status
      - file_counts
      title: VectorStoreFileBatch
      description: A group of files attached to a vector store in one request.
    VectorStoreFileCreateParams:
      properties:
        file_id:
          type: string
          pattern: ^file[-_][a-z0-9]{32}$
          title: File Id
          description: The ID of an uploaded file the vector store should index.
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: Up to 16 key-value pairs stored with the file and usable in
            search `filters`. Keys are at most 64 characters; values are strings of
            at most 512 characters, numbers, or booleans.
        chunking_strategy:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/AutoChunkingStrategyParam'
            - $ref: '#/components/schemas/StaticChunkingStrategyParam'
            discriminator:
              propertyName: type
              mapping:
                auto: '#/components/schemas/AutoChunkingStrategyParam'
                static: '#/components/schemas/StaticChunkingStrategyParam'
          - type: 'null'
          title: Chunking Strategy
          description: How this file is split before indexing.
      type: object
      required:
      - file_id
      title: VectorStoreFileCreateParams
      description: Request body of `POST /v1/vector_stores/{vector_store_id}/files`.
    VectorStoreFileDeleted:
      properties:
        id:
          type: string
          title: Id
          description: The file identifier.
        object:
          type: string
          const: vector_store.file.deleted
          title: Object
          description: The object type.
          default: vector_store.file.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Whether the file was detached.
      additionalProperties: false
      type: object
      required:
      - id
      - deleted
      title: VectorStoreFileDeleted
      description: Confirmation that a file was detached from a vector store.
    VectorStoreFileUpdateParams:
      properties:
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: Up to 16 key-value pairs stored with the file and usable in
            search `filters`. Keys are at most 64 characters; values are strings of
            at most 512 characters, numbers, or booleans.
      type: object
      required:
      - attributes
      title: VectorStoreFileUpdateParams
      description: Request body of `POST /v1/vector_stores/{vector_store_id}/files/{file_id}`.
    VectorStoreSearchParams:
      properties:
        query:
          anyOf:
          - type: string
            minLength: 1
          - items:
              type: string
              minLength: 1
            type: array
            maxItems: 16
            minItems: 1
          title: Query
          description: The text to search for, or up to 16 texts searched together.
        max_num_results:
          type: integer
          maximum: 50.0
          minimum: 1.0
          title: Max Num Results
          description: Maximum number of results to return.
          default: 10
        filters:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_vector_stores__ComparisonFilter'
          - $ref: '#/components/schemas/stdapi__types__openai_vector_stores__CompoundFilter'
          - type: 'null'
          title: Filters
          description: Restrict results by file `attributes`.
        ranking_options:
          anyOf:
          - $ref: '#/components/schemas/RankingOptions'
          - type: 'null'
          description: Result ranking options.
        rewrite_query:
          type: boolean
          title: Rewrite Query
          description: Reserved for query rewriting. The query is searched as written,
            so this value does not change the results.
          default: false
      type: object
      required:
      - query
      title: VectorStoreSearchParams
      description: Request body of `POST /v1/vector_stores/{vector_store_id}/search`.
    VectorStoreSearchResult:
      properties:
        file_id:
          type: string
          title: File Id
          description: The file the content comes from.
        filename:
          type: string
          title: Filename
          description: The name of that file.
        score:
          type: number
          title: Score
          description: Relevance of the result, best match first. A similarity between
            0 and 1, or, on a vector store that measures its own relevance, that measure
            reported unchanged — comparable within this page only.
        attributes:
          anyOf:
          - additionalProperties:
              anyOf:
              - type: boolean
              - type: number
              - type: string
                maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Attributes
          description: The attributes stored with the file.
        content:
          items:
            $ref: '#/components/schemas/SearchResultContent'
          type: array
          title: Content
          description: The matching content.
      additionalProperties: false
      type: object
      required:
      - file_id
      - filename
      - score
      - content
      title: VectorStoreSearchResult
      description: One search hit.
    VectorStoreSearchResultsPage:
      properties:
        object:
          type: string
          const: vector_store.search_results.page
          title: Object
          description: The object type.
          default: vector_store.search_results.page
        search_query:
          items:
            type: string
          type: array
          title: Search Query
          description: The query that was searched.
        data:
          items:
            $ref: '#/components/schemas/VectorStoreSearchResult'
          type: array
          title: Data
          description: The results.
        has_more:
          type: boolean
          title: Has More
          description: Always `false`.
          default: false
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: Always `null`.
      additionalProperties: false
      type: object
      required:
      - search_query
      - data
      title: VectorStoreSearchResultsPage
      description: One page of search results.
    VectorStoreUpdateParams:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 256
          - type: 'null'
          title: Name
          description: A new name for the vector store.
        expires_after:
          anyOf:
          - $ref: '#/components/schemas/ExpiresAfter'
          - type: 'null'
          description: A new expiration policy; `null` removes the current one.
        metadata:
          anyOf:
          - additionalProperties:
              type: string
              maxLength: 512
            propertyNames:
              maxLength: 64
            type: object
            maxProperties: 16
          - type: 'null'
          title: Metadata
          description: Up to 16 key-value pairs stored with the vector store. Keys
            are at most 64 characters and values at most 512 characters.
      type: object
      title: VectorStoreUpdateParams
      description: Request body of `POST /v1/vector_stores/{vector_store_id}`.
    VectorStoresResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        object:
          type: string
          const: organization.usage.vector_stores.result
          title: Object
          default: organization.usage.vector_stores.result
        usage_bytes:
          type: integer
          title: Usage Bytes
          description: Bytes stored in vector stores.
          default: 0
      additionalProperties: false
      type: object
      title: VectorStoresResult
      description: Aggregated vector store storage of one time bucket.
    VersionResponse:
      properties:
        version:
          type: string
          title: Version
          description: Ollama API version this server is compatible with.
      additionalProperties: false
      type: object
      required:
      - version
      title: VersionResponse
      description: Version response.
    Video:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the video job.
        object:
          type: string
          const: video
          title: Object
          description: The object type, which is always `video`.
          default: video
        model:
          type: string
          title: Model
          description: The video generation model that produced the job.
        status:
          type: string
          enum:
          - queued
          - in_progress
          - completed
          - failed
          title: Status
          description: Current lifecycle status of the job.
        progress:
          type: integer
          title: Progress
          description: Approximate completion percentage.
          default: 0
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (in seconds) when the job was created.
        completed_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Completed At
          description: Unix timestamp (in seconds) when the job completed, if finished.
        expires_at:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires At
          description: Unix timestamp (in seconds) when the video will expire, when
            a retention period is configured on the server.
        seconds:
          type: string
          title: Seconds
          description: Duration of the generated clip in seconds.
        size:
          type: string
          title: Size
          description: Resolution of the generated video.
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
          description: The prompt used to generate the video, when known.
        remixed_from_video_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Remixed From Video Id
          description: ID of the source video for remixes. Always `null` (remix is
            not available on this implementation).
        error:
          anyOf:
          - $ref: '#/components/schemas/VideoError'
          - type: 'null'
          description: Error payload when generation failed.
      additionalProperties: false
      type: object
      required:
      - id
      - model
      - status
      - created_at
      - seconds
      - size
      title: Video
      description: Video generation job (OpenAI Videos API).
    VideoDeleted:
      properties:
        id:
          type: string
          title: Id
          description: Identifier of the deleted video.
        object:
          type: string
          const: video.deleted
          title: Object
          description: The object type, which is always `video.deleted`.
          default: video.deleted
        deleted:
          type: boolean
          title: Deleted
          description: Whether the video was deleted.
          default: true
      additionalProperties: false
      type: object
      required:
      - id
      title: VideoDeleted
      description: Video deletion confirmation.
    VideoError:
      properties:
        code:
          type: string
          title: Code
          description: Machine-readable error code.
        message:
          type: string
          title: Message
          description: Human-readable description of the error.
      additionalProperties: false
      type: object
      required:
      - code
      - message
      title: VideoError
      description: Error payload explaining why a video generation failed.
    VideoList:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more results exist after this page.
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Id
          description: ID of the first item in the list, or null when empty.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Id
          description: ID of the last item in the list, or null when empty.
        object:
          type: string
          const: list
          title: Object
          description: The object type, which is always `list`.
          default: list
        data:
          items:
            $ref: '#/components/schemas/Video'
          type: array
          title: Data
          description: List of Video objects.
      additionalProperties: false
      type: object
      required:
      - has_more
      - data
      title: VideoList
      description: Paginated list of video jobs returned by GET /v1/videos.
    WebFetchBlock:
      properties:
        content:
          $ref: '#/components/schemas/DocumentBlock'
          description: Block content.
        retrieved_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Retrieved At
          description: ISO 8601 timestamp when the content was retrieved
        type:
          type: string
          const: web_fetch_result
          title: Type
          description: Type discriminator.
        url:
          type: string
          title: Url
          description: Fetched content URL
      additionalProperties: false
      type: object
      required:
      - content
      - type
      - url
      title: WebFetchBlock
      description: Web fetch block.
    WebFetchBlockParam:
      properties:
        content:
          $ref: '#/components/schemas/DocumentBlockParam'
          description: Block content.
        type:
          type: string
          const: web_fetch_result
          title: Type
          description: Type discriminator.
        url:
          type: string
          title: Url
          description: Fetched content URL
        retrieved_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Retrieved At
          description: ISO 8601 timestamp when the content was retrieved
      type: object
      required:
      - content
      - type
      - url
      title: WebFetchBlockParam
      description: Web fetch block parameter.
    WebFetchToolParam:
      properties:
        name:
          type: string
          const: web_fetch
          title: Name
          description: Tool name.
        type:
          type: string
          pattern: ^web_fetch(?:_[0-9]{8})?$
          title: Type
          description: Type discriminator.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        allowed_domains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Domains
          description: List of domains to allow fetching from
        blocked_domains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Blocked Domains
          description: List of domains to block fetching from
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        citations:
          anyOf:
          - $ref: '#/components/schemas/CitationsConfigParam'
          - type: 'null'
          description: Citations configuration for fetched documents.  Citations are
            disabled by default.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        max_content_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Content Tokens
          description: Maximum number of tokens used by including web page text content
            in the context.  The limit is approximate and does not apply to binary
            content such as PDFs.
        max_uses:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Uses
          description: Maximum number of times the tool can be used in the API request.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
      type: object
      required:
      - name
      - type
      title: WebFetchToolParam
      description: Web fetch tool parameter.
    WebFetchToolResultBlock:
      properties:
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
        content:
          anyOf:
          - $ref: '#/components/schemas/WebFetchToolResultErrorBlock'
          - $ref: '#/components/schemas/WebFetchBlock'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: web_fetch_tool_result
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: WebFetchToolResultBlock
      description: Web fetch tool result block.
    WebFetchToolResultBlockParam:
      properties:
        content:
          anyOf:
          - $ref: '#/components/schemas/WebFetchToolResultErrorBlockParam'
          - $ref: '#/components/schemas/WebFetchBlockParam'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: web_fetch_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: WebFetchToolResultBlockParam
      description: Web fetch tool result block parameter.
    WebFetchToolResultErrorBlock:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - url_too_long
          - url_not_allowed
          - url_not_in_prior_context
          - url_not_accessible
          - unsupported_content_type
          - too_many_requests
          - max_uses_exceeded
          - unavailable
          - content_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: web_fetch_tool_result_error
          title: Type
          description: Type discriminator.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: WebFetchToolResultErrorBlock
      description: Web fetch tool result error block.
    WebFetchToolResultErrorBlockParam:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - url_too_long
          - url_not_allowed
          - url_not_in_prior_context
          - url_not_accessible
          - unsupported_content_type
          - too_many_requests
          - max_uses_exceeded
          - unavailable
          - content_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: web_fetch_tool_result_error
          title: Type
          description: Type discriminator.
      type: object
      required:
      - error_code
      - type
      title: WebFetchToolResultErrorBlockParam
      description: Web fetch tool result error block parameter.
    WebSearchActionFind:
      properties:
        pattern:
          type: string
          title: Pattern
          description: Pattern to find in page.
        type:
          type: string
          const: find_in_page
          title: Type
          description: Find in page action type.
        url:
          type: string
          title: Url
          description: Page URL searched.
      additionalProperties: false
      type: object
      required:
      - pattern
      - type
      - url
      title: WebSearchActionFind
      description: Web search action of type `find_in_page`.
    WebSearchActionOpenPage:
      properties:
        type:
          type: string
          const: open_page
          title: Type
          description: Open page action type.
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
          description: Opened URL.
      additionalProperties: false
      type: object
      required:
      - type
      title: WebSearchActionOpenPage
      description: Web search action of type `open_page`.
    WebSearchActionSearch:
      properties:
        query:
          type: string
          title: Query
          description: '[DEPRECATED] Search query.'
        type:
          type: string
          const: search
          title: Type
          description: Search action type.
        queries:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Queries
          description: Search queries.
        sources:
          anyOf:
          - items:
              $ref: '#/components/schemas/WebSearchActionSource'
            type: array
          - type: 'null'
          title: Sources
          description: Search sources.
      additionalProperties: false
      type: object
      required:
      - query
      - type
      title: WebSearchActionSearch
      description: Web search action of type `search`.
    WebSearchActionSource:
      properties:
        type:
          type: string
          const: url
          title: Type
          description: URL source type.
        url:
          type: string
          title: Url
          description: Source URL.
      additionalProperties: false
      type: object
      required:
      - type
      - url
      title: WebSearchActionSource
      description: A source used in the search.
    WebSearchCallInput:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the web search tool call.
        action:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          type: object
          title: Action
          description: The action taken in this web search call (search, open_page,
            or find_in_page).
        status:
          type: string
          enum:
          - in_progress
          - searching
          - completed
          - incomplete
          - failed
          title: Status
          description: The status of the web search tool call.
        type:
          type: string
          const: web_search_call
          title: Type
          description: The type of the web search tool call. Always `web_search_call`.
      type: object
      required:
      - id
      - action
      - status
      - type
      title: WebSearchCallInput
      description: The results of a web search tool call (as input item).
    WebSearchFilters:
      properties:
        allowed_domains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Domains
          description: Allowed domains for the search.
      type: object
      title: WebSearchFilters
      description: Filters for web search.
    WebSearchOptions:
      properties:
        search_context_size:
          type: string
          enum:
          - low
          - medium
          - high
          title: Search Context Size
          description: How much search context to retrieve. Accepted and ignored —
            the search runs with the amount the model applies.
          default: medium
        user_location:
          anyOf:
          - $ref: '#/components/schemas/WebSearchOptionsUserLocation'
          - type: 'null'
          description: 'Approximate location to search from. UNSUPPORTED on this implementation:
            setting it is rejected rather than searching worldwide.'
      additionalProperties: false
      type: object
      title: WebSearchOptions
      description: Web search tool options.
    WebSearchOptionsUserLocation:
      properties:
        type:
          type: string
          const: approximate
          title: Type
          description: Location type. Always `approximate`. UNSUPPORTED on this implementation.
        approximate:
          $ref: '#/components/schemas/WebSearchOptionsUserLocationApproximate'
          description: Approximate location parameters. UNSUPPORTED on this implementation.
      additionalProperties: false
      type: object
      required:
      - type
      - approximate
      title: WebSearchOptionsUserLocation
      description: 'User location parameters for web search (approximate).


        UNSUPPORTED on this implementation.'
    WebSearchOptionsUserLocationApproximate:
      properties:
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: User city, e.g., `San Francisco`. UNSUPPORTED on this implementation.
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: Two-letter ISO country code, e.g., `US`. UNSUPPORTED on this
            implementation.
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
          description: User region, e.g., `California`. UNSUPPORTED on this implementation.
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          description: IANA timezone, e.g., `America/Los_Angeles`. UNSUPPORTED on
            this implementation.
      additionalProperties: false
      type: object
      title: WebSearchOptionsUserLocationApproximate
      description: 'Approximate user location for web search.


        UNSUPPORTED on this implementation.'
    WebSearchPreviewTool:
      properties:
        type:
          type: string
          enum:
          - web_search_preview
          - web_search_preview_2025_03_11
          title: Type
          description: Web search preview tool type.
        search_content_types:
          anyOf:
          - items:
              type: string
              enum:
              - text
              - image
            type: array
          - type: 'null'
          title: Search Content Types
          description: Content types to include in search results.
        search_context_size:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
          - type: 'null'
          title: Search Context Size
          description: 'Context window size: `low`, `medium`, or `high`. Default:
            `medium`.'
        user_location:
          anyOf:
          - $ref: '#/components/schemas/WebSearchPreviewUserLocation'
          - type: 'null'
          description: User's location.
      type: object
      required:
      - type
      title: WebSearchPreviewTool
      description: 'This tool searches the web for relevant results to use in a response.


        Whether a search may reach the external web is a server setting. Where the

        server allows choosing it, send the boolean `external_web_access` as a

        top-level extra parameter of the request; a value the server does not

        allow is rejected.'
    WebSearchPreviewUserLocation:
      properties:
        type:
          type: string
          const: approximate
          title: Type
          description: Approximate location type.
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: User's city.
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: User's ISO country code.
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
          description: User's region.
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          description: User's IANA timezone.
      type: object
      required:
      - type
      title: WebSearchPreviewUserLocation
      description: The user's location for web search preview.
    WebSearchResultBlock:
      properties:
        type:
          type: string
          const: web_search_result
          title: Type
          description: Result type. Always `web_search_result`.
        encrypted_content:
          anyOf:
          - type: string
          - type: 'null'
          title: Encrypted Content
          description: Encrypted web page content.
        title:
          type: string
          title: Title
          description: Title of the web page.
        url:
          type: string
          title: Url
          description: URL of the web page.
        page_age:
          anyOf:
          - type: string
          - type: 'null'
          title: Page Age
          description: Age of the page (e.g., '2 days ago').
      additionalProperties: false
      type: object
      required:
      - type
      - title
      - url
      title: WebSearchResultBlock
      description: Individual web search result.
    WebSearchResultBlockParam:
      properties:
        encrypted_content:
          type: string
          title: Encrypted Content
          description: Encrypted web page content.
        title:
          type: string
          title: Title
          description: The title.
        type:
          type: string
          const: web_search_result
          title: Type
          description: Type discriminator.
        url:
          type: string
          title: Url
          description: The URL.
        page_age:
          anyOf:
          - type: string
          - type: 'null'
          title: Page Age
          description: How long ago the page was published or updated.
      type: object
      required:
      - encrypted_content
      - title
      - type
      - url
      title: WebSearchResultBlockParam
      description: Web search result block parameter.
    WebSearchTool:
      properties:
        type:
          type: string
          enum:
          - web_search
          - web_search_2025_08_26
          title: Type
          description: Web search tool type.
        filters:
          anyOf:
          - $ref: '#/components/schemas/WebSearchFilters'
          - type: 'null'
          description: Search filters.
        search_context_size:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
          - type: 'null'
          title: Search Context Size
          description: 'Context window size: `low`, `medium`, or `high`. Default:
            `medium`.'
        user_location:
          anyOf:
          - $ref: '#/components/schemas/WebSearchUserLocation'
          - type: 'null'
          description: User's approximate location.
      type: object
      required:
      - type
      title: WebSearchTool
      description: 'Search the web for sources related to the prompt.


        Whether a search may reach the external web is a server setting. Where the

        server allows choosing it, send the boolean `external_web_access` as a

        top-level extra parameter of the request; a value the server does not

        allow is rejected.'
    WebSearchToolParam:
      properties:
        type:
          type: string
          pattern: ^web_search(?:_[0-9]{8})?$
          title: Type
          description: Tool type.
        name:
          type: string
          const: web_search
          title: Name
          description: Name of the tool, used to call it in `tool_use` blocks.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        allowed_callers:
          anyOf:
          - items:
              type: string
              pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Allowed callers.
        allowed_domains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Domains
          description: If provided, only these domains will be included in results.  Cannot
            be used alongside `blocked_domains`.
        blocked_domains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Blocked Domains
          description: If provided, these domains will never appear in results.  Cannot
            be used alongside `allowed_domains`.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Defer loading tool until referenced by tool_search.
        max_uses:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Uses
          description: Maximum number of times the tool can be used in the API request.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: Enable strict schema validation
        user_location:
          anyOf:
          - $ref: '#/components/schemas/UserLocationParam'
          - type: 'null'
          description: Parameters for the user's location.  Used to provide more relevant
            search results.
      type: object
      required:
      - type
      - name
      title: WebSearchToolParam
      description: 'Web search tool definition.


        Supported on models that declare web search as a system tool.'
    WebSearchToolRequestErrorParam:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - max_uses_exceeded
          - too_many_requests
          - query_too_long
          - request_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: web_search_tool_result_error
          title: Type
          description: Type discriminator.
      type: object
      required:
      - error_code
      - type
      title: WebSearchToolRequestErrorParam
      description: Web search tool request error parameter.
    WebSearchToolResultBlock:
      properties:
        type:
          type: string
          const: web_search_tool_result
          title: Type
          description: Content block type. Always `web_search_tool_result`.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: ID of the tool use this result corresponds to.
        content:
          anyOf:
          - $ref: '#/components/schemas/WebSearchToolResultError'
          - items:
              $ref: '#/components/schemas/WebSearchResultBlock'
            type: array
          title: Content
          description: Search results or error.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
      additionalProperties: false
      type: object
      required:
      - type
      - tool_use_id
      - content
      title: WebSearchToolResultBlock
      description: Web search tool result content block.
    WebSearchToolResultBlockParam:
      properties:
        content:
          anyOf:
          - items:
              $ref: '#/components/schemas/WebSearchResultBlockParam'
            type: array
          - $ref: '#/components/schemas/WebSearchToolRequestErrorParam'
          title: Content
          description: Block content.
        tool_use_id:
          type: string
          title: Tool Use Id
          description: Tool use ID.
        type:
          type: string
          const: web_search_tool_result
          title: Type
          description: Type discriminator.
        cache_control:
          anyOf:
          - $ref: '#/components/schemas/CacheControlEphemeralParam'
          - type: 'null'
          description: Cache control breakpoint.
        caller:
          anyOf:
          - $ref: '#/components/schemas/DirectCaller'
          - $ref: '#/components/schemas/ServerToolCaller'
          - type: 'null'
          title: Caller
          description: Caller.
      type: object
      required:
      - content
      - tool_use_id
      - type
      title: WebSearchToolResultBlockParam
      description: Web search tool result block parameter.
    WebSearchToolResultError:
      properties:
        error_code:
          type: string
          enum:
          - invalid_tool_input
          - unavailable
          - max_uses_exceeded
          - too_many_requests
          - query_too_long
          - request_too_large
          title: Error Code
          description: Error code.
        type:
          type: string
          const: web_search_tool_result_error
          title: Type
          description: Result type. Always `web_search_tool_result_error`.
      additionalProperties: false
      type: object
      required:
      - error_code
      - type
      title: WebSearchToolResultError
      description: Web search tool result error.
    WebSearchUserLocation:
      properties:
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
          description: User's city.
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
          description: User's ISO country code.
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
          description: User's region.
        timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Timezone
          description: User's IANA timezone.
        type:
          anyOf:
          - type: string
            const: approximate
          - type: 'null'
          title: Type
          description: Approximate location type.
      type: object
      title: WebSearchUserLocation
      description: The approximate location of the user.
    WebSearchesResult:
      properties:
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Set when grouping by project_id.
        user_id:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
          description: Set when grouping by user_id.
        api_key_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Key Id
          description: Set when grouping by api_key_id.
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: Set when grouping by model.
        num_model_requests:
          type: integer
          title: Num Model Requests
          description: Number of requests made to the model.
          default: 0
        object:
          type: string
          const: organization.usage.web_searches.result
          title: Object
          default: organization.usage.web_searches.result
        num_requests:
          type: integer
          title: Num Requests
          description: Number of web search requests.
          default: 0
        context_level:
          anyOf:
          - type: string
          - type: 'null'
          title: Context Level
          description: Set when grouping by context_level.
      additionalProperties: false
      type: object
      title: WebSearchesResult
      description: Aggregated web search usage of one time bucket.
    _DeveloperContentPartTextParam:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content part type. Always `text`.
        text:
          type: string
          title: Text
          description: Text content of the message part.
        prompt_cache_breakpoint:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheBreakpoint'
          - type: 'null'
          description: Cache the prompt prefix ending with this content part. Honored
            on models supporting prompt caching, accepted and ignored on the others.
      type: object
      required:
      - type
      - text
      title: _DeveloperContentPartTextParam
      description: Text part of a developer message, where upstream refuses an unknown
        field.
    stdapi__types__anthropic_messages__OutputTokensDetails:
      properties:
        thinking_tokens:
          type: integer
          title: Thinking Tokens
          description: Output tokens the model generated as internal reasoning, including
            the thinking-block delimiters. Always at most `output_tokens`, which stays
            the authoritative billed total.
      additionalProperties: false
      type: object
      required:
      - thinking_tokens
      title: OutputTokensDetails
      description: Output token usage breakdown.
    stdapi__types__anthropic_messages__Usage:
      properties:
        input_tokens:
          type: integer
          title: Input Tokens
          description: Input tokens.
        output_tokens:
          type: integer
          title: Output Tokens
          description: Output tokens.
        cache_creation_input_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cache Creation Input Tokens
          description: Cache creation input tokens.
        cache_read_input_tokens:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cache Read Input Tokens
          description: Cache read input tokens.
        cache_creation:
          anyOf:
          - $ref: '#/components/schemas/CacheCreation'
          - type: 'null'
          description: Cache creation details.
        output_tokens_details:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__anthropic_messages__OutputTokensDetails'
          - type: 'null'
          description: Output token breakdown by category.
        inference_geo:
          anyOf:
          - type: string
          - type: 'null'
          title: Inference Geo
          description: Inference geographic region.
        server_tool_use:
          anyOf:
          - $ref: '#/components/schemas/ServerToolUsage'
          - type: 'null'
          description: Server tool usage.
        service_tier:
          anyOf:
          - type: string
            enum:
            - standard
            - priority
            - batch
          - type: 'null'
          title: Service Tier
          description: The service tier used for the request.
      additionalProperties: false
      type: object
      required:
      - input_tokens
      - output_tokens
      title: Usage
      description: Token usage information.
    stdapi__types__cohere_embed__EmbedRequest:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        texts:
          anyOf:
          - items:
              type: string
            type: array
            minItems: 1
          - type: 'null'
          title: Texts
          description: An array of strings for the model to embed.
        images:
          anyOf:
          - items:
              type: string
              minLength: 1
              pattern: ^(?:https?://|s3://|data:|file-id:)
            type: array
            minItems: 1
          - type: 'null'
          title: Images
          description: An array of image data URIs for the model to embed. URLs and
            S3 URIs are also accepted (beyond the original Cohere API).
        embedding_types:
          anyOf:
          - items:
              type: string
              enum:
              - float
              - int8
              - uint8
              - binary
              - ubinary
              - base64
            type: array
          - type: 'null'
          title: Embedding Types
          description: Embedding types to return. `int8`/`uint8`/`binary`/`ubinary`
            are supported by Cohere Embed models, `binary` also by Titan Embed v2;
            other combinations return 400. `base64` is always accepted and computed
            client-side (little-endian float32 bytes) from the `float` embedding.
        truncate:
          anyOf:
          - type: string
            enum:
            - NONE
            - START
            - END
          - type: 'null'
          title: Truncate
          description: How to handle inputs longer than the maximum token length.
            Supported by Cohere models only.
        inputs:
          anyOf:
          - items:
              $ref: '#/components/schemas/EmbedInput'
            type: array
            minItems: 1
          - type: 'null'
          title: Inputs
          description: Inputs to embed, one vector each, as objects carrying a `content`
            array of `text` and `image_url` parts. Embedded after `texts` and `images`
            when those are sent too.
        input_type:
          type: string
          enum:
          - search_document
          - search_query
          - classification
          - clustering
          - image
          title: Input Type
          description: Specifies the type of input passed to the model. Applied to
            Cohere models; other embedding models have no equivalent and the value
            is ignored.
        output_dimension:
          anyOf:
          - type: integer
            maximum: 8192.0
            minimum: 1.0
          - type: 'null'
          title: Output Dimension
          description: The number of dimensions of the output embedding. Supported
            by some models only.
        max_tokens:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Tokens
          description: The maximum number of tokens to embed per input. Supported
            by some models only.
        priority:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Priority
          description: Accepted for compatibility and ignored. Cohere API request
            scheduling priority is not applicable on this implementation.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - input_type
      title: EmbedRequest
      description: Request body for creating embeddings.
    stdapi__types__cohere_embed__EmbedResponse:
      properties:
        response_type:
          type: string
          const: embeddings_by_type
          title: Response Type
          description: Response envelope type, always `embeddings_by_type`.
          default: embeddings_by_type
        id:
          type: string
          title: Id
          description: Unique identifier of the request.
        embeddings:
          $ref: '#/components/schemas/EmbeddingsByType'
          description: Embeddings grouped by embedding type.
        texts:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Texts
          description: The text entries for which embeddings were returned.
        images:
          anyOf:
          - items:
              $ref: '#/components/schemas/ImageDescription'
            type: array
          - type: 'null'
          title: Images
          description: Metadata of the image entries for which embeddings were returned.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      additionalProperties: false
      type: object
      required:
      - id
      - embeddings
      - meta
      title: EmbedResponse
      description: Embed response model.
    stdapi__types__ollama__EmbedRequest:
      properties:
        model:
          type: string
          title: Model
          description: Model name.
        input:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          title: Input
          description: Text, or texts, to embed.
        dimensions:
          anyOf:
          - type: integer
          - type: 'null'
          title: Dimensions
          description: Number of dimensions of the returned vectors.
        truncate:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Truncate
          description: 'UNSUPPORTED, accepted and ignored: inputs longer than the
            context window are handled by the backend.'
        keep_alive:
          anyOf:
          - type: string
          - type: number
          - type: 'null'
          title: Keep Alive
          description: 'UNSUPPORTED, accepted and ignored: models are never resident.'
        options:
          anyOf:
          - $ref: '#/components/schemas/ModelOptions'
          - type: 'null'
          description: Runtime options; ignored for embeddings.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - input
      title: EmbedRequest
      description: Create embeddings request.
    stdapi__types__ollama__EmbedResponse:
      properties:
        model:
          type: string
          title: Model
          description: Model name, as the request spelled it.
        embeddings:
          items:
            items:
              type: number
            type: array
          type: array
          title: Embeddings
          description: One embedding vector per input, in request order.
        total_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Duration
          description: Total time spent answering, in nanoseconds.
        prompt_eval_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Prompt Eval Count
          description: Number of input tokens.
      additionalProperties: false
      type: object
      required:
      - model
      - embeddings
      title: EmbedResponse
      description: Embeddings response.
    stdapi__types__openai_chat_completions__AnnotationURLCitation:
      properties:
        end_index:
          type: integer
          minimum: 0.0
          title: End Index
          description: Last character index of the URL citation in the message.
        start_index:
          type: integer
          minimum: 0.0
          title: Start Index
          description: First character index of the URL citation in the message.
        title:
          type: string
          title: Title
          description: Title of the web resource.
        url:
          type: string
          title: Url
          description: URL of the web resource.
      additionalProperties: false
      type: object
      required:
      - end_index
      - start_index
      - title
      - url
      title: AnnotationURLCitation
      description: A URL citation when using web search.
    stdapi__types__openai_chat_completions__CompletionCreateParams:
      properties:
        messages:
          items:
            oneOf:
            - $ref: '#/components/schemas/ChatCompletionDeveloperMessageParam'
            - $ref: '#/components/schemas/ChatCompletionSystemMessageParam'
            - $ref: '#/components/schemas/ChatCompletionUserMessageParam'
            - $ref: '#/components/schemas/ChatCompletionAssistantMessageParam'
            - $ref: '#/components/schemas/ChatCompletionToolMessageParam'
            - $ref: '#/components/schemas/ChatCompletionFunctionMessageParam'
            discriminator:
              propertyName: role
              mapping:
                assistant: '#/components/schemas/ChatCompletionAssistantMessageParam'
                developer: '#/components/schemas/ChatCompletionDeveloperMessageParam'
                function: '#/components/schemas/ChatCompletionFunctionMessageParam'
                system: '#/components/schemas/ChatCompletionSystemMessageParam'
                tool: '#/components/schemas/ChatCompletionToolMessageParam'
                user: '#/components/schemas/ChatCompletionUserMessageParam'
          type: array
          minItems: 1
          title: Messages
          description: List of messages comprising the conversation. Supports text,
            document, video, image, and audio depending on the model.
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: Model ID to generate the response. Wildcard patterns are accepted
            and select the most recent matching model.
        audio:
          anyOf:
          - $ref: '#/components/schemas/ChatCompletionAudioParam'
          - type: 'null'
          description: Audio output parameters. Required when `modalities=['audio']`.
        frequency_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Frequency Penalty
          description: Penalize token repetition based on frequency. Only supported
            on some models.
        function_call:
          anyOf:
          - type: string
            enum:
            - none
            - auto
          - $ref: '#/components/schemas/FunctionToolChoiceParam'
          - type: 'null'
          title: Function Call
          description: Deprecated. Use `tool_choice` instead. Controls which function
            is called.
          deprecated: true
        functions:
          anyOf:
          - items:
              $ref: '#/components/schemas/LegacyFunction'
            type: array
          - type: 'null'
          title: Functions
          description: Deprecated. Use `tools` instead. List of functions the model
            can call.
          deprecated: true
        logit_bias:
          anyOf:
          - additionalProperties:
              type: integer
            type: object
          - type: 'null'
          title: Logit Bias
          description: Token likelihood modification via token ID to bias mapping.
            Only supported on some models.
        logprobs:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Logprobs
          description: Return log probabilities of output tokens. UNSUPPORTED on this
            implementation.
          default: false
        max_completion_tokens:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Completion Tokens
          description: Upper bound for tokens in completion, including reasoning tokens.
        max_tokens:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Tokens
          description: Deprecated. Use `max_completion_tokens` instead.
          deprecated: true
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metadata
          description: Key-value pairs for filtering invocation logs.
        modalities:
          anyOf:
          - items:
              type: string
              enum:
              - text
              - audio
            type: array
          - type: 'null'
          title: Modalities
          description: 'Output types to generate. Default: `[''text'']`. Audio is
            synthesized from text for text-only models.'
        n:
          anyOf:
          - type: integer
            maximum: 128.0
            minimum: 1.0
          - type: 'null'
          title: N
          description: Number of completion choices to generate. n>1 with streaming
            is UNSUPPORTED.
          default: 1
        parallel_tool_calls:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Parallel Tool Calls
          description: Enable parallel function calling. Accepted for every model;
            `false` is honored only by models able to constrain tool use, and the
            response reports the tool calls actually made.
          default: true
        prediction:
          anyOf:
          - $ref: '#/components/schemas/ChatCompletionPredictionContentParam'
          - type: 'null'
          description: 'Static predicted output content. A latency hint that does
            not change the answer: accepted and ignored, except on Bedrock Mantle
            passthrough models, which forward it upstream.'
        presence_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Presence Penalty
          description: Penalize new tokens based on prior appearance. Only supported
            on some models.
        prompt_cache_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Cache Key
          description: Cache key for similar requests. Use dot-separated 'system',
            'messages', 'tools' for section-specific caching. Custom hash keys are
            UNSUPPORTED.
        prompt_cache_options:
          anyOf:
          - $ref: '#/components/schemas/stdapi__types__openai_chat_completions__PromptCacheOptions'
          - type: 'null'
          description: Prompt caching options. `ttl` `30m` is applied as 1h unless
            `prompt_cache_retention` is set.
        prompt_cache_retention:
          anyOf:
          - type: string
            enum:
            - in_memory
            - 24h
            - 1h
            - 5m
          - type: 'null'
          title: Prompt Cache Retention
          description: 'Cache retention: `in_memory` is applied as 5m, `24h` as 1h.'
        reasoning_effort:
          anyOf:
          - type: string
            enum:
            - none
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          - type: 'null'
          title: Reasoning Effort
          description: 'Reasoning effort: `none`, `minimal`, `low`, `medium`, `high`,
            `xhigh`, `max`. On budget-based models, calculated as a fraction of `max_completion_tokens`:
            `low`=0.25x, `medium`=0.5x, `high`=0.75x, `xhigh`/`max`=1x (`minimal`
            uses the minimal budget).'
        response_format:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/ResponseFormatText'
            - $ref: '#/components/schemas/ResponseFormatJSONSchema'
            - $ref: '#/components/schemas/ResponseFormatJSONObject'
            discriminator:
              propertyName: type
              mapping:
                json_object: '#/components/schemas/ResponseFormatJSONObject'
                json_schema: '#/components/schemas/ResponseFormatJSONSchema'
                text: '#/components/schemas/ResponseFormatText'
          - type: 'null'
          title: Response Format
          description: 'Output format. `json_object` is best effort: the content may
            be invalid JSON or wrapped in a Markdown code fence. Use `json_schema`
            when the output has to parse.'
        safety_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Safety Identifier
          description: Stable user identifier for usage policy detection. Recommend
            hashing username/email.
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
          description: Seed for deterministic sampling. Not guaranteed. Only supported
            on some models.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - reserved
          - type: 'null'
          title: Service Tier
          description: 'Processing tier: `priority` (lowest, most consistent latency;
            `fast` is an alias), `flex` (cost-efficient), `reserved` (reserved capacity);
            any other value is served on the standard tier. The response reports the
            requested tier after alias mapping.'
        stop:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop
          description: Stop sequences. Generation halts at the first match and nothing
            after it is returned. Whether the matched sequence itself is kept at the
            end of the text depends on the model, so do not rely on it as an end-of-answer
            marker; some models refuse the parameter outright.
        store:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Store
          description: Persist the chat completion for later retrieval. Defaults to
            false on this implementation. Ignored (with a request-log warning) when
            streaming or when storage is not enabled on the server.
        stream_options:
          anyOf:
          - $ref: '#/components/schemas/ChatCompletionStreamOptionsParam'
          - type: 'null'
          description: 'Streaming options. Only set when `stream: true`. Only `include_usage`
            is supported.'
        temperature:
          anyOf:
          - type: number
            minimum: 0.0
          - type: 'null'
          title: Temperature
          description: Sampling temperature. Higher values increase randomness, lower
            values increase determinism. Use `top_p` or `temperature`, not both. Only
            supported on some models; accepted and ignored on some models with fixed
            sampling.
        tool_choice:
          anyOf:
          - type: string
            enum:
            - none
            - auto
            - required
          - oneOf:
            - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceParam'
            - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam'
            - $ref: '#/components/schemas/ChatCompletionAllowedToolChoiceParam'
            discriminator:
              propertyName: type
              mapping:
                allowed_tools: '#/components/schemas/ChatCompletionAllowedToolChoiceParam'
                custom: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam'
                function: '#/components/schemas/ChatCompletionNamedToolChoiceParam'
          - type: 'null'
          title: Tool Choice
          description: 'Tool selection: `none` (no tool), `auto` (model decides),
            `required` (must call tool), or specify a tool by name.'
        tools:
          anyOf:
          - items:
              oneOf:
              - $ref: '#/components/schemas/ChatCompletionFunctionToolParam'
              - $ref: '#/components/schemas/ChatCompletionCustomToolParam'
              discriminator:
                propertyName: type
                mapping:
                  custom: '#/components/schemas/ChatCompletionCustomToolParam'
                  function: '#/components/schemas/ChatCompletionFunctionToolParam'
            type: array
          - type: 'null'
          title: Tools
          description: List of tools the model may call (custom or function tools).
        top_logprobs:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Top Logprobs
          description: Number of most likely tokens to return at each position with
            log probabilities. Only supported on some models.
        top_p:
          anyOf:
          - type: number
            minimum: 0.0
          - type: 'null'
          title: Top P
          description: 'Nucleus sampling: considers tokens comprising top_p probability
            mass. Use `temperature` or `top_p`, not both. Only supported on some models;
            accepted and ignored on some models with fixed sampling.'
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: Deprecated. Use `safety_identifier` or `prompt_cache_key` instead.
            End-user identifier.
          deprecated: true
        verbosity:
          anyOf:
          - type: string
            enum:
            - low
            - medium
            - high
          - type: 'null'
          title: Verbosity
          description: Response verbosity. Accepted and ignored — steer the answer
            length from the prompt instead — except on Bedrock Mantle passthrough
            models, which forward it upstream.
        web_search_options:
          anyOf:
          - $ref: '#/components/schemas/WebSearchOptions'
          - type: 'null'
          description: 'Ground the answer in a web search run before the model replies,
            cited in the message `annotations`. Model-dependent: a model that runs
            no web search rejects the request.'
        stream:
          type: boolean
          title: Stream
          description: Stream response data to client using server-sent events.
          default: false
        amazon-bedrock-guardrailConfig:
          anyOf:
          - $ref: '#/components/schemas/AmazonBedrockGuardrailConfigParams'
          - type: 'null'
          description: Amazon Bedrock Guardrail configuration.
        top_k:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Top K
          description: Candidate set size for sampling. Larger increases randomness,
            smaller increases determinism. Extra field from Qwen Chat Completion API.
        enable_thinking:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enable Thinking
          description: Enable thinking/reasoning mode. Extra field from Qwen Chat
            Completion API.
        thinking_budget:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Thinking Budget
          description: 'Max thinking length in tokens. Requires `enable_thinking:
            true`. Default: model''s max chain-of-thought length. Extra field from
            Qwen Chat Completion API.'
        translation_options:
          anyOf:
          - $ref: '#/components/schemas/QwenTranslationOptions'
          - type: 'null'
          description: Translation options (source/target languages, terms, memory,
            domains). Extra field from Qwen Chat Completion API. UNSUPPORTED on this
            implementation.
        thinking:
          anyOf:
          - $ref: '#/components/schemas/MoonshotThinkingOptions'
          - type: 'null'
          description: Enable/disable thinking. Extra field from Moonshot Chat Completion
            API.
        reasoning:
          anyOf:
          - $ref: '#/components/schemas/ReasoningOptions'
          - type: 'null'
          description: Reasoning options, equivalent to `reasoning_effort`, `thinking_budget`
            and `enable_thinking`. Conflicting values are rejected. Extra field from
            OpenRouter Chat Completion API.
        include_reasoning:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Include Reasoning
          description: 'Include the reasoning text in the response; `false` is equivalent
            to `reasoning.exclude: true`. Extra field from OpenRouter Chat Completion
            API.'
        moderation:
          anyOf:
          - $ref: '#/components/schemas/RequestModeration'
          - type: 'null'
          description: Apply an AWS Bedrock guardrail to this request; results are
            reported in the response `moderation` field, or, when streaming, in a
            dedicated moderation chunk sent last.
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - messages
      - model
      title: CompletionCreateParams
      description: Create chat completion request following OpenAI API specification.
    stdapi__types__openai_chat_completions__CustomTool:
      properties:
        name:
          type: string
          title: Name
          description: 'The name of the custom tool to call.

            UNSUPPORTED on this implementation.'
        input:
          type: string
          title: Input
          description: 'The input for the custom tool call generated by the model.

            UNSUPPORTED on this implementation.'
      type: object
      required:
      - name
      - input
      title: CustomTool
      description: 'Custom tool call payload used within assistant tool calls.


        UNSUPPORTED on this implementation.'
    stdapi__types__openai_chat_completions__PromptCacheBreakpoint:
      properties:
        mode:
          type: string
          const: explicit
          title: Mode
          description: 'Breakpoint mode. Always `explicit`: the prompt prefix ending
            with this content part is cached.'
          default: explicit
      type: object
      title: PromptCacheBreakpoint
      description: Explicit prompt-cache breakpoint set on a content part.
    stdapi__types__openai_chat_completions__PromptCacheOptions:
      properties:
        mode:
          anyOf:
          - type: string
            enum:
            - implicit
            - explicit
          - type: 'null'
          title: Mode
          description: 'Caching mode. `explicit`: only content parts marked with `prompt_cache_breakpoint`
            are cached. `implicit` (default): sections selected with `prompt_cache_key`
            are cached too.'
        ttl:
          anyOf:
          - type: string
            const: 30m
          - type: 'null'
          title: Ttl
          description: 'Cache retention: `30m` is applied as 1h. Ignored when `prompt_cache_retention`
            is set.'
      type: object
      title: PromptCacheOptions
      description: Prompt caching options.
    stdapi__types__openai_completions__CompletionCreateParams:
      properties:
        model:
          type: string
          maxLength: 255
          minLength: 1
          title: Model
          description: ID of the model to use. Wildcard patterns are accepted and
            select the most recent matching model.
        prompt:
          anyOf:
          - type: string
            minLength: 1
            pattern: ^(?:https?://|s3://|data:|file-id:)
          - type: string
          - items:
              anyOf:
              - type: string
                minLength: 1
                pattern: ^(?:https?://|s3://|data:|file-id:)
              - type: string
            type: array
          title: Prompt
          description: 'The prompt(s) to generate completions for: a single string
            or array of strings. Non-inline prompts can be a URL, S3 URI, base64 data
            URI, or Files API reference. Each file is forwarded using its detected
            modality; the model errors if unsupported.

            An array with exactly one text string and file prompts is sent as a single
            multimodal request. Other array shapes return one choice per element.
            Token arrays are UNSUPPORTED on this implementation.'
        max_tokens:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Tokens
          description: The maximum number of tokens to generate. Prompt tokens plus
            max_tokens cannot exceed the model's context length.
        temperature:
          anyOf:
          - type: number
            maximum: 2.0
            minimum: 0.0
          - type: 'null'
          title: Temperature
          description: Sampling temperature. Higher values (e.g. 0.8) make output
            more random; lower values (e.g. 0.2) make it more focused. We generally
            recommend altering this or ``top_p`` but not both.
        top_p:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Top P
          description: 'Nucleus sampling: the model considers only tokens within the
            top ``top_p`` probability mass. We generally recommend altering this or
            ``temperature`` but not both.'
        stop:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          - type: 'null'
          title: Stop
          description: Up to 4 sequences where the API will stop generating. Generation
            halts at the first match and nothing after it is returned. Whether the
            matched sequence itself is kept at the end of the text depends on the
            model, so do not rely on it as an end-of-answer marker; some models refuse
            the parameter outright.
        stream:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Stream
          description: 'If true, partial completion deltas are sent as server-sent
            events as they become available, terminated by a ``data: [DONE]`` message.'
        stream_options:
          anyOf:
          - $ref: '#/components/schemas/ChatCompletionStreamOptionsParam'
          - type: 'null'
          description: Options that apply only when ``stream`` is ``True``.
        n:
          anyOf:
          - type: integer
            maximum: 128.0
            minimum: 1.0
          - type: 'null'
          title: N
          description: How many completions to generate for each prompt. The number
            of prompts times this value must not exceed 128.
        user:
          anyOf:
          - type: string
          - type: 'null'
          title: User
          description: Deprecated by OpenAI in favor of ``safety_identifier``. A unique
            identifier representing your end-user.
        service_tier:
          anyOf:
          - type: string
            enum:
            - auto
            - default
            - flex
            - scale
            - priority
            - fast
            - reserved
          - type: 'null'
          title: Service Tier
          description: 'Processing tier: `priority` (lowest, most consistent latency;
            `fast` is an alias), `flex` (cost-efficient), `reserved` (reserved capacity);
            any other value is served on the standard tier.'
        safety_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Safety Identifier
          description: A stable identifier for detecting users who may be violating
            usage policies. Prefer a hash of username or email over the raw value.
        prompt_cache_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Cache Key
          description: Controls prompt caching for similar requests to reduce costs
            and improve response times. Any non-empty value enables caching; a dot-separated
            list of 'system', 'messages', and/or 'tools' scopes it to specific prompt
            sections. Custom hash keys are UNSUPPORTED in this implementation.
        prompt_cache_retention:
          anyOf:
          - type: string
            enum:
            - in_memory
            - 24h
            - 1h
            - 5m
          - type: 'null'
          title: Prompt Cache Retention
          description: The retention policy for the prompt cache. `in_memory` is applied
            as 5m, `24h` as 1h.
        best_of:
          anyOf:
          - type: integer
          - type: 'null'
          title: Best Of
          description: 'Generates ``best_of`` completions server-side and returns
            the one with the highest log probability per token. Results cannot be
            streamed, and ``best_of`` must be greater than ``n``.

            UNSUPPORTED in this implementation.'
        echo:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Echo
          description: 'Echo back the prompt in addition to the completion: each choice''s
            text is prefixed with the prompt it was generated from (one leading chunk
            per choice when streamed). A file-only prompt echoes nothing.'
        frequency_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Frequency Penalty
          description: 'Number between -2.0 and 2.0. Positive values penalize tokens
            by their existing frequency so far, reducing verbatim repetition.

            UNSUPPORTED in this implementation.'
        logit_bias:
          anyOf:
          - additionalProperties:
              type: number
            type: object
          - type: 'null'
          title: Logit Bias
          description: 'Maps token IDs (GPT tokenizer) to a bias value from -100 to
            100 to modify their likelihood of appearing in the completion.

            UNSUPPORTED in this implementation.'
        logprobs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Logprobs
          description: 'Include the log probabilities on the ``logprobs`` most likely
            output tokens (max 5), as well as the chosen tokens.

            UNSUPPORTED in this implementation.'
        presence_penalty:
          anyOf:
          - type: number
          - type: 'null'
          title: Presence Penalty
          description: 'Number between -2.0 and 2.0. Positive values penalize tokens
            that already appear in the text so far, encouraging new topics.

            UNSUPPORTED in this implementation.'
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
          description: 'If specified, the system makes a best effort to sample deterministically
            for repeated requests with the same ``seed`` and parameters. Determinism
            is not guaranteed.

            UNSUPPORTED in this implementation.'
        suffix:
          anyOf:
          - type: string
          - type: 'null'
          title: Suffix
          description: 'The suffix that comes after a completion of inserted text
            (OpenAI: ``gpt-3.5-turbo-instruct`` only).

            UNSUPPORTED in this implementation.'
      additionalProperties:
        $ref: '#/components/schemas/JsonValue'
      type: object
      required:
      - model
      - prompt
      title: CompletionCreateParams
      description: Request body for the OpenAI completions API (``POST /v1/completions``).
    stdapi__types__openai_conversations__Conversation:
      properties:
        id:
          type: string
          title: Id
          description: The unique ID of the conversation.
        object:
          type: string
          const: conversation
          title: Object
          description: The object type. Always `conversation`.
        created_at:
          type: integer
          title: Created At
          description: Unix timestamp (seconds) of when the conversation was created.
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Key-value pairs attached to the conversation.
      additionalProperties: false
      type: object
      required:
      - id
      - object
      - created_at
      - metadata
      title: Conversation
      description: A conversation holding items shared across model responses.
    stdapi__types__openai_embeddings__Usage:
      properties:
        prompt_tokens:
          type: integer
          minimum: 0.0
          title: Prompt Tokens
          description: The number of tokens used by the prompt.
          default: 0
        total_tokens:
          type: integer
          minimum: 0.0
          title: Total Tokens
          description: The total number of tokens used by the request.
          default: 0
      additionalProperties: false
      type: object
      title: Usage
      description: Embedding usage accounting compatible with OpenAI.
    stdapi__types__openai_images__Usage:
      properties:
        input_tokens:
          type: integer
          minimum: 0.0
          title: Input Tokens
          description: Number of tokens (images + text) in the input prompt.
          default: 0
        input_tokens_details:
          $ref: '#/components/schemas/UsageInputTokensDetails'
          description: Detailed breakdown of input token usage.
        output_tokens:
          type: integer
          minimum: 0.0
          title: Output Tokens
          description: Number of output tokens generated.
          default: 0
        total_tokens:
          type: integer
          minimum: 0.0
          title: Total Tokens
          description: Total tokens used (input + output).
          default: 0
      additionalProperties: false
      type: object
      required:
      - input_tokens_details
      title: Usage
      description: Image generation token usage information.
    stdapi__types__openai_realtime__FunctionTool:
      properties:
        type:
          type: string
          const: function
          title: Type
          description: Kind of tool being declared.
          default: function
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name the model calls the function by; an entry without one
            is ignored, since nothing can be called.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: What the function does, which is how the model decides to call
            it.
        parameters:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Parameters
          description: JSON Schema of the arguments the function takes.
      type: object
      title: FunctionTool
      description: One function the model may call during the session.
    stdapi__types__openai_responses__AnnotationURLCitation:
      properties:
        end_index:
          type: integer
          title: End Index
          description: Last character index of URL citation.
        start_index:
          type: integer
          title: Start Index
          description: First character index of URL citation.
        title:
          type: string
          title: Title
          description: Web resource title.
        type:
          type: string
          const: url_citation
          title: Type
          description: URL citation type.
        url:
          type: string
          title: Url
          description: Web resource URL.
      additionalProperties: false
      type: object
      required:
      - end_index
      - start_index
      - title
      - type
      - url
      title: AnnotationURLCitation
      description: A citation for a web resource used to generate a model response.
    stdapi__types__openai_responses__ComparisonFilter:
      properties:
        key:
          type: string
          title: Key
          description: The key to compare against.
        type:
          type: string
          enum:
          - eq
          - ne
          - gt
          - gte
          - lt
          - lte
          - in
          - nin
          title: Type
          description: 'Comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`,
            `in`, or `nin`.'
        value:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - items:
              anyOf:
              - type: string
              - type: number
            type: array
          title: Value
          description: The value to compare against the key.
      type: object
      required:
      - key
      - type
      - value
      title: ComparisonFilter
      description: Compares a specified attribute key to a given value using a defined
        operator.
    stdapi__types__openai_responses__CompoundFilter:
      properties:
        filters:
          items:
            anyOf:
            - $ref: '#/components/schemas/stdapi__types__openai_responses__ComparisonFilter'
            - {}
          type: array
          title: Filters
          description: Array of filters to combine.
        type:
          type: string
          enum:
          - and
          - or
          title: Type
          description: 'Combine operation: `and` or `or`.'
      type: object
      required:
      - filters
      - type
      title: CompoundFilter
      description: Combine multiple filters using `and` or `or`.
    stdapi__types__openai_responses__Conversation:
      properties:
        id:
          type: string
          title: Id
          description: Conversation ID.
      additionalProperties: false
      type: object
      required:
      - id
      title: Conversation
      description: The conversation that this response belonged to.
    stdapi__types__openai_responses__CustomTool:
      properties:
        name:
          type: string
          title: Name
          description: Custom tool name.
        type:
          type: string
          const: custom
          title: Type
          description: Custom tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Deferred and discovered via tool search.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Tool description.
        format:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/CustomToolInputFormatText'
            - $ref: '#/components/schemas/CustomToolInputFormatGrammar'
            discriminator:
              propertyName: type
              mapping:
                grammar: '#/components/schemas/CustomToolInputFormatGrammar'
                text: '#/components/schemas/CustomToolInputFormatText'
          - type: 'null'
          title: Format
          description: 'Input format. Default: unconstrained text.'
      type: object
      required:
      - name
      - type
      title: CustomTool
      description: 'A custom tool that processes input using a specified format.


        UNSUPPORTED on this implementation.'
    stdapi__types__openai_responses__FunctionTool:
      properties:
        name:
          type: string
          title: Name
          description: Function name.
        type:
          type: string
          const: function
          title: Type
          description: Function tool type.
        allowed_callers:
          anyOf:
          - items:
              type: string
              enum:
              - direct
              - programmatic
            type: array
          - type: 'null'
          title: Allowed Callers
          description: Caller types allowed to invoke this tool.
        defer_loading:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Defer Loading
          description: Whether this function is deferred and loaded via tool search.
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Function description for the model.
        output_schema:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Output Schema
          description: JSON schema describing the function output.
        parameters:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/JsonValue'
            type: object
          - type: 'null'
          title: Parameters
          description: JSON schema for function parameters.
        strict:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Strict
          description: 'Enforce strict parameter validation. Default: true.'
      type: object
      required:
      - name
      - type
      title: FunctionTool
      description: Defines a function in your own code the model can choose to call.
    stdapi__types__openai_responses__OutputTokensDetails:
      properties:
        reasoning_tokens:
          type: integer
          title: Reasoning Tokens
          description: Reasoning token count.
          default: 0
      additionalProperties: false
      type: object
      title: OutputTokensDetails
      description: A detailed breakdown of the output tokens.
    stdapi__types__openai_responses__PromptCacheBreakpoint:
      properties:
        mode:
          type: string
          const: explicit
          title: Mode
          description: 'Breakpoint mode. Always `explicit`: the prompt prefix ending
            with this content part is cached.'
          default: explicit
      type: object
      title: PromptCacheBreakpoint
      description: Explicit prompt-cache breakpoint set on an input content part.
    stdapi__types__openai_responses__PromptCacheOptions:
      properties:
        mode:
          anyOf:
          - type: string
            enum:
            - implicit
            - explicit
          - type: 'null'
          title: Mode
          description: 'Caching mode. `explicit`: only content parts marked with `prompt_cache_breakpoint`
            are cached. `implicit` (default): sections selected with `prompt_cache_key`
            are cached too.'
        ttl:
          anyOf:
          - type: string
            const: 30m
          - type: 'null'
          title: Ttl
          description: 'Cache retention: `30m` is applied as 1h. Ignored when `prompt_cache_retention`
            is set.'
      type: object
      title: PromptCacheOptions
      description: Explicit prompt-caching configuration for a request.
    stdapi__types__openai_vector_stores__ComparisonFilter:
      properties:
        key:
          type: string
          title: Key
          description: The attribute key to compare.
        type:
          type: string
          enum:
          - eq
          - ne
          - gt
          - gte
          - lt
          - lte
          - in
          - nin
          title: Type
          description: The comparison operator.
        value:
          anyOf:
          - type: boolean
          - type: number
          - type: string
          - items:
              anyOf:
              - type: number
              - type: string
            type: array
          title: Value
          description: The value compared against; a number for `gt`, `gte`, `lt`
            and `lte`, a list for `in` and `nin`.
      type: object
      required:
      - key
      - type
      - value
      title: ComparisonFilter
      description: Compares one attribute key against a value.
    stdapi__types__openai_vector_stores__CompoundFilter:
      properties:
        type:
          type: string
          enum:
          - and
          - or
          title: Type
          description: How the filters are combined.
        filters:
          items:
            anyOf:
            - $ref: '#/components/schemas/stdapi__types__openai_vector_stores__ComparisonFilter'
            - additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
          type: array
          minItems: 1
          title: Filters
          description: The filters to combine; an entry may itself be a compound filter.
      type: object
      required:
      - type
      - filters
      title: CompoundFilter
      description: Combines several filters.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
