> ## Documentation Index
> Fetch the complete documentation index at: https://nemonist.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create transcription

> Transcribes audio into text. Accepts base64-encoded audio input as JSON, an OpenAI-style multipart/form-data file upload, or a URL the provider downloads directly, and returns the transcribed text.



## OpenAPI

````yaml /openapi.json post /audio/transcriptions
openapi: 3.1.0
info:
  title: Nemonist API
  version: 1.0.0
  description: >-
    OpenRouter-compatible API with durable per-workspace memory. Point any
    OpenRouter client at https://nemonist.com/api/v1 with a Nemonist key
    (sk-nm-...). Chat completions, Responses and Messages requests from a
    workspace carrying a .nemonist/key get its memory; every other request is
    answered as OpenRouter would.
  contact:
    name: Nemonist
    url: https://nemonist.com
servers:
  - url: https://nemonist.com/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - description: API key management endpoints
    name: API Keys
  - description: Analytics and usage endpoints
    name: Analytics
  - description: Anthropic Messages endpoints
    name: Anthropic Messages
  - description: BYOK endpoints
    name: BYOK
  - description: Benchmarks endpoints
    name: Benchmarks
  - description: Chat completion endpoints
    name: Chat
  - description: Credit management endpoints
    name: Credits
  - description: >-
      Public OpenRouter usage datasets. Data returned by these endpoints is
      licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/):
      reuse and republish it, including commercially, with attribution to
      OpenRouter.
    name: Datasets
  - description: Text embedding endpoints
    name: Embeddings
  - description: Endpoint information
    name: Endpoints
  - name: Folders
    description: >-
      Your memory folders, over your account's API key: read, export, upload,
      and manage keys.
  - description: Generation history endpoints
    name: Generations
  - description: Guardrails endpoints
    name: Guardrails
  - description: Images endpoints
    name: Images
  - name: Memory
    description: Nemonist's per-workspace memory.
  - name: Model runs
    description: Run models (physics and others) on inputs; one contract for every model
  - description: Model information endpoints
    name: Models
  - description: OAuth authentication endpoints
    name: OAuth
  - description: Organization endpoints
    name: Organization
  - description: Private Endpoints endpoints
    name: Private Endpoints
  - description: Provider information endpoints
    name: Providers
  - description: Rerank endpoints
    name: Rerank
  - description: OpenAI-compatible Responses API endpoints
    name: Responses
  - description: Speech-to-text endpoints
    name: STT
    x-displayName: Transcriptions
  - description: >-
      System One endpoints for models such as Jev, compatible with the TypeSafe
      SDKs. See https://openrouter.ai/docs/guides/community/typesafe-sdk.
    name: SystemOne
    x-displayName: System One
  - description: Text-to-speech endpoints
    name: TTS
    x-displayName: Speech
  - description: Video Generation endpoints
    name: Video Generation
  - description: Workspaces endpoints
    name: Workspaces
  - name: beta.responses
    description: >-
      Deprecated alias of responses. Use responses instead; scheduled for
      removal (sunset date TBD).
paths:
  /audio/transcriptions:
    parameters:
      - $ref: '#/components/parameters/AppIdentifier'
      - $ref: '#/components/parameters/AppDisplayName'
      - $ref: '#/components/parameters/AppCategories'
    post:
      tags:
        - STT
      summary: Create transcription
      description: >-
        Transcribes audio into text. Accepts base64-encoded audio input as JSON,
        an OpenAI-style multipart/form-data file upload, or a URL the provider
        downloads directly, and returns the transcribed text.
      operationId: createAudioTranscriptions
      requestBody:
        content:
          application/json:
            example:
              input_audio:
                data: UklGRiQA...
                format: wav
              language: en
              model: openai/whisper-large-v3
            schema:
              $ref: '#/components/schemas/STTRequest'
          multipart/form-data:
            example:
              file: audio.wav
              language: en
              model: openai/whisper-large-v3
            schema:
              properties:
                diarize:
                  description: >-
                    Label each word with the speaker who said it
                    (words[].speaker, words[].speaker_label). Requires
                    response_format "verbose_json" (400 otherwise); word
                    timestamps are included even when timestamp_granularities[]
                    omits "word". Only supported by some providers; 400 when the
                    selected model cannot diarize.
                  type: boolean
                file:
                  description: >-
                    The audio file to transcribe. The format is derived from the
                    filename extension or the file part content type. Max 25 MB;
                    send larger files as base64 JSON via input_audio, or by URL
                    via source_url. Exactly one of file or source_url is
                    required.
                  format: binary
                  type: string
                keyterms[]:
                  description: >-
                    Domain terms, names, or phrases to bias recognition toward;
                    repeat the part once per term (keyterms=... is also
                    accepted). Only supported by some providers; 400 when the
                    selected model cannot use keyterms.
                  items:
                    maxLength: 100
                    type: string
                  maxItems: 1000
                  type: array
                language:
                  description: The language of the input audio (ISO-639-1).
                  type: string
                model:
                  description: The model to use for transcription.
                  type: string
                provider:
                  description: >-
                    JSON-encoded provider preferences object, the same shape as
                    the JSON body field: { "zdr": true, "data_collection":
                    "deny", "options": { "<provider-slug>": { ... } } }. Only
                    options for the matched provider are forwarded. Must decode
                    to a JSON object.
                  type: string
                response_format:
                  description: >-
                    The response format. "json" (default) returns { text, usage
                    }; "verbose_json" additionally returns task, language,
                    duration, and segment-level timestamps (OpenAI-compatible
                    providers only).
                  enum:
                    - json
                    - verbose_json
                  type: string
                  x-speakeasy-unknown-values: allow
                session_id:
                  description: >-
                    A unique identifier for grouping related requests (e.g., a
                    conversation or agent workflow). Used for observability
                    grouping in Broadcast and private logging; never sent to the
                    provider. If provided in both the request body and the
                    x-session-id header, the body value takes precedence.
                  maxLength: 256
                  type: string
                source_url:
                  description: >-
                    Publicly reachable http(s) URL of the audio file, downloaded
                    by the provider directly (no size limit on our side). The
                    format is derived from the URL path extension. Only
                    supported by some providers; exactly one of file or
                    source_url is required.
                  format: uri
                  maxLength: 8000
                  type: string
                temperature:
                  description: The sampling temperature.
                  maximum: 1
                  minimum: 0
                  type: number
                timestamp_granularities[]:
                  description: >-
                    Timestamp detail levels to include when response_format is
                    "verbose_json". "word" additionally returns word-level
                    timestamps in the words array.
                  items:
                    enum:
                      - word
                      - segment
                    type: string
                    x-speakeasy-unknown-values: allow
                  type: array
                trace:
                  description: >-
                    JSON-encoded trace metadata object (trace_id, trace_name,
                    span_name, generation_name, parent_span_id and custom keys)
                    attached to the Broadcast trace. Must decode to a JSON
                    object.
                  type: string
                user:
                  description: >-
                    A unique identifier representing your end-user. Forwarded to
                    Broadcast and private logging as the end-user id; never sent
                    to the provider.
                  maxLength: 256
                  type: string
              required:
                - model
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                text: Hello, this is a test of OpenAI speech-to-text transcription.
                usage:
                  cost: 0.000508
                  input_tokens: 83
                  output_tokens: 30
                  seconds: 9.2
                  total_tokens: 113
              schema:
                $ref: '#/components/schemas/STTResponse'
          description: Transcription result
        '400':
          content:
            application/json:
              example:
                error:
                  code: 400
                  message: Invalid request parameters
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
          description: Bad Request - Invalid request parameters or malformed input
        '401':
          content:
            application/json:
              example:
                error:
                  code: 401
                  message: Missing Authentication header
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized - Authentication required or invalid credentials
        '402':
          content:
            application/json:
              example:
                error:
                  code: 402
                  message: >-
                    Insufficient credits. Add more using
                    https://openrouter.ai/credits
              schema:
                $ref: '#/components/schemas/PaymentRequiredResponse'
          description: >-
            Payment Required - Insufficient credits or quota to complete
            request. Nemonist: over a spending cap, or out of credits.
        '403':
          content:
            application/json:
              example:
                error:
                  code: 403
                  message: Only management keys can perform this operation
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden - Authentication successful but insufficient permissions
        '404':
          content:
            application/json:
              example:
                error:
                  code: 404
                  message: Resource not found
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found - Resource does not exist
        '413':
          content:
            application/json:
              example:
                error:
                  code: 413
                  message: Request payload too large
              schema:
                $ref: '#/components/schemas/PayloadTooLargeResponse'
          description: Payload Too Large - Request payload exceeds size limits
        '429':
          content:
            application/json:
              example:
                error:
                  code: 429
                  message: Rate limit exceeded
              schema:
                $ref: '#/components/schemas/TooManyRequestsResponse'
          description: >-
            Too Many Requests - Rate limit exceeded. Nemonist: admission limit
            reached; retry after the Retry-After header's seconds.
        '500':
          content:
            application/json:
              example:
                error:
                  code: 500
                  message: Internal Server Error
              schema:
                $ref: '#/components/schemas/InternalServerResponse'
          description: Internal Server Error - Unexpected server error
        '502':
          content:
            application/json:
              example:
                error:
                  code: 502
                  message: Provider returned error
              schema:
                $ref: '#/components/schemas/BadGatewayResponse'
          description: Bad Gateway - Provider/upstream API failure
        '503':
          content:
            application/json:
              example:
                error:
                  code: 503
                  message: Service temporarily unavailable
              schema:
                $ref: '#/components/schemas/ServiceUnavailableResponse'
          description: Service Unavailable - Service temporarily unavailable
        '504':
          content:
            application/json:
              example:
                error:
                  code: 504
                  message: The operation was aborted due to timeout
              schema:
                $ref: '#/components/schemas/GatewayTimeoutResponse'
          description: >-
            Gateway Timeout - Provider did not respond before the upstream
            deadline
        '524':
          content:
            application/json:
              example:
                error:
                  code: 524
                  message: Request timed out. Please try again later.
              schema:
                $ref: '#/components/schemas/EdgeNetworkTimeoutResponse'
          description: Infrastructure Timeout - Provider request timed out at edge network
        '529':
          content:
            application/json:
              example:
                error:
                  code: 529
                  message: Provider returned error
              schema:
                $ref: '#/components/schemas/ProviderOverloadedResponse'
          description: Provider Overloaded - Provider is temporarily overloaded
components:
  parameters:
    AppIdentifier:
      name: HTTP-Referer
      in: header
      schema:
        type: string
      description: >
        The app identifier should be your app's URL and is used as the primary
        identifier for rankings.

        This is used to track API usage per application.
    AppDisplayName:
      name: X-OpenRouter-Title
      in: header
      x-speakeasy-name-override: appTitle
      schema:
        type: string
      description: >
        The app display name allows you to customize how your app appears in
        OpenRouter's dashboard.
    AppCategories:
      name: X-OpenRouter-Categories
      in: header
      x-speakeasy-name-override: appCategories
      schema:
        type: string
      description: >
        Comma-separated list of app categories (e.g. "cli-agent,cloud-agent").
        Used for marketplace rankings.
  schemas:
    STTRequest:
      description: >-
        Speech-to-text request input. Accepts a JSON body with input_audio
        containing base64-encoded audio or a URL the provider downloads.
      example:
        input_audio:
          data: UklGRiQA...
          format: wav
        language: en
        model: openai/whisper-large-v3
      properties:
        diarize:
          description: >-
            Label each word with the speaker who said it. Speaker labels are
            returned on the words array (speaker, speaker_label), so
            response_format must be "verbose_json" (a "json" request is rejected
            with a 400) and word timestamps are included even when
            timestamp_granularities omits "word". Only supported by some
            providers; the request is rejected with a 400 when the selected
            model cannot diarize. Providers may charge extra.
          example: true
          type: boolean
        input_audio:
          $ref: '#/components/schemas/STTInputAudio'
        keyterms:
          description: >-
            Domain terms, names, or phrases to bias recognition toward. Only
            supported by some providers; the request is rejected with a 400 when
            the selected model cannot use keyterms. Providers may cap the number
            of terms or characters per term and may charge extra.
          example:
            - OpenRouter
            - Scribe
          items:
            maxLength: 100
            minLength: 1
            type: string
          maxItems: 1000
          type: array
        language:
          description: >-
            ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if
            omitted.
          example: en
          type: string
        model:
          description: STT model identifier
          example: openai/whisper-large-v3
          type: string
        provider:
          description: >-
            Provider configuration: data policy routing preferences (`zdr`,
            `data_collection`) and provider-specific passthrough options
          properties:
            data_collection:
              description: >-
                Data collection setting. If no available model provider meets
                the requirement, your request will return an error.

                - allow: (default) allow providers which store user data
                non-transiently and may train on it


                - deny: use only providers which do not collect user data.
              enum:
                - deny
                - allow
                - null
              example: allow
              title: STTRequestDataCollection
              type:
                - string
                - 'null'
              x-speakeasy-unknown-values: allow
            options:
              $ref: '#/components/schemas/ProviderOptions'
            zdr:
              description: >-
                Whether to restrict routing to only ZDR (Zero Data Retention)
                endpoints. When true, only endpoints that do not retain prompts
                will be used.
              example: true
              type:
                - boolean
                - 'null'
          type: object
        response_format:
          description: >-
            Output format. "json" (default) returns { text, usage }.
            "verbose_json" additionally returns task, language, duration, and
            segment-level timestamps; only supported by OpenAI-compatible
            providers.
          enum:
            - json
            - verbose_json
          example: json
          type: string
          x-speakeasy-unknown-values: allow
        session_id:
          description: >-
            A unique identifier for grouping related requests (e.g., a
            conversation or agent workflow). Used for observability grouping in
            Broadcast and private logging; never sent to the provider. If
            provided in both the request body and the x-session-id header, the
            body value takes precedence. Maximum of 256 characters.
          example: session-1234
          maxLength: 256
          type: string
        temperature:
          description: Sampling temperature for transcription
          example: 0
          format: double
          type: number
        timestamp_granularities:
          description: >-
            Timestamp detail levels to include when response_format is
            "verbose_json". "segment" returns segment-level timestamps; "word"
            additionally returns word-level timestamps in the words array.
            Ignored unless response_format is "verbose_json".
          example:
            - segment
          items:
            $ref: '#/components/schemas/STTTimestampGranularity'
          type: array
        trace:
          $ref: '#/components/schemas/TraceConfig'
        user:
          description: >-
            A unique identifier representing your end-user. Forwarded to
            Broadcast and private logging as the end-user id; never sent to the
            provider.
          example: user-1234
          maxLength: 256
          type: string
      required:
        - model
        - input_audio
      type: object
    STTResponse:
      description: STT response containing transcribed text and optional usage statistics
      example:
        text: Hello, this is a test of OpenAI speech-to-text transcription.
        usage:
          cost: 0.000508
          input_tokens: 83
          output_tokens: 30
          seconds: 9.2
          total_tokens: 113
      properties:
        confidence:
          description: >-
            Provider confidence for the whole transcript from 0 to 1, present
            when response_format is verbose_json and the provider scores the
            full transcript
          example: 0.94
          format: double
          type: number
        duration:
          description: >-
            Duration of the input audio in seconds, present when response_format
            is verbose_json
          example: 9.2
          format: double
          type: number
        entities:
          description: >-
            Detected entities with character offsets into text, present when the
            provider runs entity detection
          items:
            $ref: '#/components/schemas/STTEntity'
          type: array
        language:
          description: >-
            Detected or forced language, present when response_format is
            verbose_json
          example: english
          type: string
        language_confidence:
          description: >-
            Provider confidence in the detected language from 0 to 1, present
            when response_format is verbose_json and the provider scores
            language detection
          example: 0.98
          format: double
          type: number
        segments:
          description: >-
            Timestamped transcript segments, present when response_format is
            verbose_json
          items:
            $ref: '#/components/schemas/STTSegment'
          type: array
        task:
          description: The task performed, present when response_format is verbose_json
          example: transcribe
          type: string
        text:
          description: The transcribed text
          example: >-
            Hello, this is a test of OpenAI speech-to-text transcription. The
            weather is sunny today and the temperature is around 72 degrees.
          type: string
        usage:
          $ref: '#/components/schemas/STTUsage'
        words:
          description: >-
            Timestamped words, present when the provider returns word-level
            timestamps
          items:
            $ref: '#/components/schemas/STTWord'
          type: array
      required:
        - text
      type: object
    BadRequestResponse:
      description: Bad Request - Invalid request parameters or malformed input
      example:
        error:
          code: 400
          message: Invalid request parameters
      properties:
        error:
          $ref: '#/components/schemas/BadRequestResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    UnauthorizedResponse:
      description: Unauthorized - Authentication required or invalid credentials
      example:
        error:
          code: 401
          message: Missing Authentication header
      properties:
        error:
          $ref: '#/components/schemas/UnauthorizedResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    PaymentRequiredResponse:
      description: Payment Required - Insufficient credits or quota to complete request
      example:
        error:
          code: 402
          message: Insufficient credits. Add more using https://openrouter.ai/credits
      properties:
        error:
          $ref: '#/components/schemas/PaymentRequiredResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ForbiddenResponse:
      description: Forbidden - Authentication successful but insufficient permissions
      example:
        error:
          code: 403
          message: Only management keys can perform this operation
      properties:
        error:
          $ref: '#/components/schemas/ForbiddenResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    NotFoundResponse:
      description: Not Found - Resource does not exist
      example:
        error:
          code: 404
          message: Resource not found
      properties:
        error:
          $ref: '#/components/schemas/NotFoundResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    PayloadTooLargeResponse:
      description: Payload Too Large - Request payload exceeds size limits
      example:
        error:
          code: 413
          message: Request payload too large
      properties:
        error:
          $ref: '#/components/schemas/PayloadTooLargeResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    TooManyRequestsResponse:
      description: Too Many Requests - Rate limit exceeded
      example:
        error:
          code: 429
          message: Rate limit exceeded
      properties:
        error:
          $ref: '#/components/schemas/TooManyRequestsResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    InternalServerResponse:
      description: Internal Server Error - Unexpected server error
      example:
        error:
          code: 500
          message: Internal Server Error
      properties:
        error:
          $ref: '#/components/schemas/InternalServerResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    BadGatewayResponse:
      description: Bad Gateway - Provider/upstream API failure
      example:
        error:
          code: 502
          message: Provider returned error
      properties:
        error:
          $ref: '#/components/schemas/BadGatewayResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ServiceUnavailableResponse:
      description: Service Unavailable - Service temporarily unavailable
      example:
        error:
          code: 503
          message: Service temporarily unavailable
      properties:
        error:
          $ref: '#/components/schemas/ServiceUnavailableResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    GatewayTimeoutResponse:
      description: Gateway Timeout - Provider did not respond before the upstream deadline
      example:
        error:
          code: 504
          message: The operation was aborted due to timeout
      properties:
        error:
          $ref: '#/components/schemas/GatewayTimeoutResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    EdgeNetworkTimeoutResponse:
      description: Infrastructure Timeout - Provider request timed out at edge network
      example:
        error:
          code: 524
          message: Request timed out. Please try again later.
      properties:
        error:
          $ref: '#/components/schemas/EdgeNetworkTimeoutResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    ProviderOverloadedResponse:
      description: Provider Overloaded - Provider is temporarily overloaded
      example:
        error:
          code: 529
          message: Provider returned error
      properties:
        error:
          $ref: '#/components/schemas/ProviderOverloadedResponseErrorData'
        openrouter_metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: OpenRouter's routing detail for the failed request.
        user_id:
          type:
            - string
            - 'null'
          description: Id of the user who made the request.
      required:
        - error
      type: object
    STTInputAudio:
      anyOf:
        - $ref: '#/components/schemas/STTInlineInputAudio'
        - $ref: '#/components/schemas/STTUrlInputAudio'
      description: >-
        Audio to transcribe: inline base64 bytes, or a URL the provider
        downloads directly.
    ProviderOptions:
      description: >-
        Provider-specific options keyed by provider slug. The provider segment
        is case-insensitive; an endpoint tag after `/` must match the endpoint
        slug exactly. Only options for the matched provider are forwarded; the
        rest are ignored. Unrecognized keys are silently dropped.
      example:
        openai:
          max_tokens: 1000
      properties:
        01ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the 01ai provider.
        ai21:
          additionalProperties: {}
          type: object
          description: Options sent only to the ai21 provider.
        aion-labs:
          additionalProperties: {}
          type: object
          description: Options sent only to the aion-labs provider.
        akashml:
          additionalProperties: {}
          type: object
          description: Options sent only to the akashml provider.
        alibaba:
          additionalProperties: {}
          type: object
          description: Options sent only to the alibaba provider.
        amazon-bedrock:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-bedrock provider.
        amazon-bedrock/claude-on-aws:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-bedrock/claude-on-aws provider.
        amazon-nova:
          additionalProperties: {}
          type: object
          description: Options sent only to the amazon-nova provider.
        ambient:
          additionalProperties: {}
          type: object
          description: Options sent only to the ambient provider.
        antdigital:
          additionalProperties: {}
          type: object
          description: Options sent only to the antdigital provider.
        anthropic:
          additionalProperties: {}
          type: object
          description: Options sent only to the anthropic provider.
        anthropic/2:
          additionalProperties: {}
          type: object
          description: Options sent only to the anthropic/2 provider.
        anyscale:
          additionalProperties: {}
          type: object
          description: Options sent only to the anyscale provider.
        arcee-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the arcee-ai provider.
        assemblyai:
          additionalProperties: {}
          type: object
          description: Options sent only to the assemblyai provider.
        atlas-cloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the atlas-cloud provider.
        atoma:
          additionalProperties: {}
          type: object
          description: Options sent only to the atoma provider.
        avian:
          additionalProperties: {}
          type: object
          description: Options sent only to the avian provider.
        azure:
          additionalProperties: {}
          type: object
          description: Options sent only to the azure provider.
        baidu:
          additionalProperties: {}
          type: object
          description: Options sent only to the baidu provider.
        baseten:
          additionalProperties: {}
          type: object
          description: Options sent only to the baseten provider.
        black-forest-labs:
          additionalProperties: {}
          type: object
          description: Options sent only to the black-forest-labs provider.
        byteplus:
          additionalProperties: {}
          type: object
          description: Options sent only to the byteplus provider.
        centml:
          additionalProperties: {}
          type: object
          description: Options sent only to the centml provider.
        cerebras:
          additionalProperties: {}
          type: object
          description: Options sent only to the cerebras provider.
        chutes:
          additionalProperties: {}
          type: object
          description: Options sent only to the chutes provider.
        cirrascale:
          additionalProperties: {}
          type: object
          description: Options sent only to the cirrascale provider.
        clarifai:
          additionalProperties: {}
          type: object
          description: Options sent only to the clarifai provider.
        claude-on-aws:
          additionalProperties: {}
          type: object
          description: Options sent only to the claude-on-aws provider.
        cloudflare:
          additionalProperties: {}
          type: object
          description: Options sent only to the cloudflare provider.
        cohere:
          additionalProperties: {}
          type: object
          description: Options sent only to the cohere provider.
        coreweave:
          additionalProperties: {}
          type: object
          description: Options sent only to the coreweave provider.
        cosine:
          additionalProperties: {}
          type: object
          description: Options sent only to the cosine provider.
        crofai:
          additionalProperties: {}
          type: object
          description: Options sent only to the crofai provider.
        crucible:
          additionalProperties: {}
          type: object
          description: Options sent only to the crucible provider.
        crusoe:
          additionalProperties: {}
          type: object
          description: Options sent only to the crusoe provider.
        darkbloom:
          additionalProperties: {}
          type: object
          description: Options sent only to the darkbloom provider.
        databricks:
          additionalProperties: {}
          type: object
          description: Options sent only to the databricks provider.
        decart:
          additionalProperties: {}
          type: object
          description: Options sent only to the decart provider.
        deepgram:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepgram provider.
        deepinfra:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepinfra provider.
        deepseek:
          additionalProperties: {}
          type: object
          description: Options sent only to the deepseek provider.
        dekallm:
          additionalProperties: {}
          type: object
          description: Options sent only to the dekallm provider.
        digitalocean:
          additionalProperties: {}
          type: object
          description: Options sent only to the digitalocean provider.
        elevenlabs:
          additionalProperties: {}
          type: object
          description: Options sent only to the elevenlabs provider.
        enfer:
          additionalProperties: {}
          type: object
          description: Options sent only to the enfer provider.
        fake-provider:
          additionalProperties: {}
          type: object
          description: Options sent only to the fake-provider provider.
        featherless:
          additionalProperties: {}
          type: object
          description: Options sent only to the featherless provider.
        fireworks:
          additionalProperties: {}
          type: object
          description: Options sent only to the fireworks provider.
        fish-audio:
          additionalProperties: {}
          type: object
          description: Options sent only to the fish-audio provider.
        friendli:
          additionalProperties: {}
          type: object
          description: Options sent only to the friendli provider.
        gmicloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the gmicloud provider.
        google-ai-studio:
          additionalProperties: {}
          type: object
          description: Options sent only to the google-ai-studio provider.
        google-vertex:
          additionalProperties: {}
          type: object
          description: Options sent only to the google-vertex provider.
        gopomelo:
          additionalProperties: {}
          type: object
          description: Options sent only to the gopomelo provider.
        groq:
          additionalProperties: {}
          type: object
          description: Options sent only to the groq provider.
        heygen:
          additionalProperties: {}
          type: object
          description: Options sent only to the heygen provider.
        huggingface:
          additionalProperties: {}
          type: object
          description: Options sent only to the huggingface provider.
        hyperbolic:
          additionalProperties: {}
          type: object
          description: Options sent only to the hyperbolic provider.
        hyperbolic-quantized:
          additionalProperties: {}
          type: object
          description: Options sent only to the hyperbolic-quantized provider.
        inception:
          additionalProperties: {}
          type: object
          description: Options sent only to the inception provider.
        inceptron:
          additionalProperties: {}
          type: object
          description: Options sent only to the inceptron provider.
        inferact-vllm:
          additionalProperties: {}
          type: object
          description: Options sent only to the inferact-vllm provider.
        inference-net:
          additionalProperties: {}
          type: object
          description: Options sent only to the inference-net provider.
        infermatic:
          additionalProperties: {}
          type: object
          description: Options sent only to the infermatic provider.
        inflection:
          additionalProperties: {}
          type: object
          description: Options sent only to the inflection provider.
        inocloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the inocloud provider.
        io-net:
          additionalProperties: {}
          type: object
          description: Options sent only to the io-net provider.
        ionstream:
          additionalProperties: {}
          type: object
          description: Options sent only to the ionstream provider.
        klusterai:
          additionalProperties: {}
          type: object
          description: Options sent only to the klusterai provider.
        krea:
          additionalProperties: {}
          type: object
          description: Options sent only to the krea provider.
        kt:
          additionalProperties: {}
          type: object
          description: Options sent only to the kt provider.
        lambda:
          additionalProperties: {}
          type: object
          description: Options sent only to the lambda provider.
        lepton:
          additionalProperties: {}
          type: object
          description: Options sent only to the lepton provider.
        liquid:
          additionalProperties: {}
          type: object
          description: Options sent only to the liquid provider.
        lynn:
          additionalProperties: {}
          type: object
          description: Options sent only to the lynn provider.
        lynn-private:
          additionalProperties: {}
          type: object
          description: Options sent only to the lynn-private provider.
        makora:
          additionalProperties: {}
          type: object
          description: Options sent only to the makora provider.
        mancer:
          additionalProperties: {}
          type: object
          description: Options sent only to the mancer provider.
        mancer-old:
          additionalProperties: {}
          type: object
          description: Options sent only to the mancer-old provider.
        mara:
          additionalProperties: {}
          type: object
          description: Options sent only to the mara provider.
        meta:
          additionalProperties: {}
          type: object
          description: Options sent only to the meta provider.
        minimax:
          additionalProperties: {}
          type: object
          description: Options sent only to the minimax provider.
        mistral:
          additionalProperties: {}
          type: object
          description: Options sent only to the mistral provider.
        modal:
          additionalProperties: {}
          type: object
          description: Options sent only to the modal provider.
        modelrun:
          additionalProperties: {}
          type: object
          description: Options sent only to the modelrun provider.
        modular:
          additionalProperties: {}
          type: object
          description: Options sent only to the modular provider.
        moonshotai:
          additionalProperties: {}
          type: object
          description: Options sent only to the moonshotai provider.
        morph:
          additionalProperties: {}
          type: object
          description: Options sent only to the morph provider.
        ncompass:
          additionalProperties: {}
          type: object
          description: Options sent only to the ncompass provider.
        near-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the near-ai provider.
        nebius:
          additionalProperties: {}
          type: object
          description: Options sent only to the nebius provider.
        nex-agi:
          additionalProperties: {}
          type: object
          description: Options sent only to the nex-agi provider.
        nextbit:
          additionalProperties: {}
          type: object
          description: Options sent only to the nextbit provider.
        nineteen:
          additionalProperties: {}
          type: object
          description: Options sent only to the nineteen provider.
        novita:
          additionalProperties: {}
          type: object
          description: Options sent only to the novita provider.
        nvidia:
          additionalProperties: {}
          type: object
          description: Options sent only to the nvidia provider.
        octoai:
          additionalProperties: {}
          type: object
          description: Options sent only to the octoai provider.
        ollama:
          additionalProperties: {}
          type: object
          description: Options sent only to the ollama provider.
        open-inference:
          additionalProperties: {}
          type: object
          description: Options sent only to the open-inference provider.
        openai:
          additionalProperties: {}
          type: object
          description: Options sent only to the openai provider.
        parallel:
          additionalProperties: {}
          type: object
          description: Options sent only to the parallel provider.
        parasail:
          additionalProperties: {}
          type: object
          description: Options sent only to the parasail provider.
        pareto-alpha:
          additionalProperties: {}
          type: object
          description: Options sent only to the pareto-alpha provider.
        particle-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the particle-ai provider.
        pearl-research:
          additionalProperties: {}
          type: object
          description: Options sent only to the pearl-research provider.
        perceptron:
          additionalProperties: {}
          type: object
          description: Options sent only to the perceptron provider.
        perplexity:
          additionalProperties: {}
          type: object
          description: Options sent only to the perplexity provider.
        phala:
          additionalProperties: {}
          type: object
          description: Options sent only to the phala provider.
        poolside:
          additionalProperties: {}
          type: object
          description: Options sent only to the poolside provider.
        primalabs:
          additionalProperties: {}
          type: object
          description: Options sent only to the primalabs provider.
        primeintellect:
          additionalProperties: {}
          type: object
          description: Options sent only to the primeintellect provider.
        quiver:
          additionalProperties: {}
          type: object
          description: Options sent only to the quiver provider.
        recraft:
          additionalProperties: {}
          type: object
          description: Options sent only to the recraft provider.
        recursal:
          additionalProperties: {}
          type: object
          description: Options sent only to the recursal provider.
        recursive:
          additionalProperties: {}
          type: object
          description: Options sent only to the recursive provider.
        reflection:
          additionalProperties: {}
          type: object
          description: Options sent only to the reflection provider.
        reka:
          additionalProperties: {}
          type: object
          description: Options sent only to the reka provider.
        relace:
          additionalProperties: {}
          type: object
          description: Options sent only to the relace provider.
        replicate:
          additionalProperties: {}
          type: object
          description: Options sent only to the replicate provider.
        respan:
          additionalProperties: {}
          type: object
          description: Options sent only to the respan provider.
        runway:
          additionalProperties: {}
          type: object
          description: Options sent only to the runway provider.
        sail-research:
          additionalProperties: {}
          type: object
          description: Options sent only to the sail-research provider.
        sakana:
          additionalProperties: {}
          type: object
          description: Options sent only to the sakana provider.
        sakana-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the sakana-ai provider.
        sambanova:
          additionalProperties: {}
          type: object
          description: Options sent only to the sambanova provider.
        sambanova-cloaked:
          additionalProperties: {}
          type: object
          description: Options sent only to the sambanova-cloaked provider.
        scaledown:
          additionalProperties: {}
          type: object
          description: Options sent only to the scaledown provider.
        seed:
          additionalProperties: {}
          type: object
          description: Options sent only to the seed provider.
        sf-compute:
          additionalProperties: {}
          type: object
          description: Options sent only to the sf-compute provider.
        siliconflow:
          additionalProperties: {}
          type: object
          description: Options sent only to the siliconflow provider.
        sourceful:
          additionalProperties: {}
          type: object
          description: Options sent only to the sourceful provider.
        stealth:
          additionalProperties: {}
          type: object
          description: Options sent only to the stealth provider.
        stepfun:
          additionalProperties: {}
          type: object
          description: Options sent only to the stepfun provider.
        streamlake:
          additionalProperties: {}
          type: object
          description: Options sent only to the streamlake provider.
        switchpoint:
          additionalProperties: {}
          type: object
          description: Options sent only to the switchpoint provider.
        targon:
          additionalProperties: {}
          type: object
          description: Options sent only to the targon provider.
        tencent:
          additionalProperties: {}
          type: object
          description: Options sent only to the tencent provider.
        tenstorrent:
          additionalProperties: {}
          type: object
          description: Options sent only to the tenstorrent provider.
        thinkingmachines:
          additionalProperties: {}
          type: object
          description: Options sent only to the thinkingmachines provider.
        together:
          additionalProperties: {}
          type: object
          description: Options sent only to the together provider.
        together-lite:
          additionalProperties: {}
          type: object
          description: Options sent only to the together-lite provider.
        typesafe:
          additionalProperties: {}
          type: object
          description: Options sent only to the typesafe provider.
        ubicloud:
          additionalProperties: {}
          type: object
          description: Options sent only to the ubicloud provider.
        unbiased:
          additionalProperties: {}
          type: object
          description: Options sent only to the unbiased provider.
        upstage:
          additionalProperties: {}
          type: object
          description: Options sent only to the upstage provider.
        venice:
          additionalProperties: {}
          type: object
          description: Options sent only to the venice provider.
        voyageai:
          additionalProperties: {}
          type: object
          description: Options sent only to the voyageai provider.
        wafer:
          additionalProperties: {}
          type: object
          description: Options sent only to the wafer provider.
        wandb:
          additionalProperties: {}
          type: object
          description: Options sent only to the wandb provider.
        wandb-legacy:
          additionalProperties: {}
          type: object
          description: Options sent only to the wandb-legacy provider.
        xai:
          additionalProperties: {}
          type: object
          description: Options sent only to the xai provider.
        xiaomi:
          additionalProperties: {}
          type: object
          description: Options sent only to the xiaomi provider.
        z-ai:
          additionalProperties: {}
          type: object
          description: Options sent only to the z-ai provider.
      type: object
    STTTimestampGranularity:
      description: A timestamp detail level for verbose_json transcription responses.
      enum:
        - word
        - segment
      example: word
      type: string
      x-speakeasy-unknown-values: allow
    TraceConfig:
      additionalProperties: {}
      description: >-
        Metadata for observability and tracing. Known keys (trace_id,
        trace_name, span_name, generation_name, parent_span_id) have special
        handling. Additional keys are passed through as custom metadata to
        configured broadcast destinations.
      example:
        trace_id: trace-abc123
        trace_name: my-app-trace
      properties:
        generation_name:
          type: string
          description: Name of this generation in your traces.
        parent_span_id:
          type: string
          description: Span this generation nests under in your traces.
        span_name:
          type: string
          description: Name of this span in your traces.
        trace_id:
          type: string
          description: Id of the trace this request belongs to.
        trace_name:
          type: string
          description: Name of the trace in your traces.
      type: object
    STTEntity:
      description: A detected entity, returned when the provider runs entity detection
      example:
        end_char: 25
        start_char: 15
        text: John Smith
        type: name
      properties:
        end_char:
          description: >-
            Zero-based exclusive character offset of the entity end within the
            response-level text (not seconds)
          example: 25
          type: integer
        start_char:
          description: >-
            Zero-based character offset of the entity start within the
            response-level text (not seconds)
          example: 15
          type: integer
        text:
          description: Entity text as it appears in the transcript
          type: string
        type:
          description: Provider entity type label
          example: name
          type: string
      required:
        - text
        - type
        - start_char
        - end_char
      type: object
    STTSegment:
      description: >-
        A timestamped transcript segment, returned when response_format is
        verbose_json
      example:
        avg_logprob: -0.28
        compression_ratio: 1.13
        end: 3.2
        id: 0
        no_speech_prob: 0.01
        seek: 0
        speaker: 0
        start: 0
        temperature: 0
        text: Hello there.
        tokens:
          - 50364
          - 2425
          - 456
      properties:
        avg_logprob:
          description: Average log probability of the segment
          format: double
          type: number
        channel:
          description: >-
            Zero-based audio channel index for the segment, present when the
            provider transcribes channels separately
          example: 0
          type: integer
        compression_ratio:
          description: Compression ratio of the segment
          format: double
          type: number
        end:
          description: Segment end time in seconds
          example: 3.2
          format: double
          type: number
        id:
          description: Segment index within the transcript
          example: 0
          type: integer
        no_speech_prob:
          description: Probability the segment contains no speech
          format: double
          type: number
        seek:
          description: Seek offset of the segment
          example: 0
          type: integer
        speaker:
          description: >-
            Speaker index for the segment, present when the provider returns
            diarization data
          example: 0
          type: integer
        speaker_label:
          description: >-
            Provider speaker label for the segment, present when the provider
            labels speakers with a string
          example: speaker_0
          type: string
        start:
          description: Segment start time in seconds
          example: 0
          format: double
          type: number
        temperature:
          description: Temperature used for the segment
          format: double
          type: number
        text:
          description: Transcribed text of the segment
          example: Hello there.
          type: string
        tokens:
          description: Token IDs of the segment
          items:
            type: integer
          type: array
      required:
        - id
        - start
        - end
        - text
      type: object
    STTUsage:
      description: Aggregated usage statistics for the request
      example:
        cost: 0.000508
        input_tokens: 83
        output_tokens: 30
        seconds: 9.2
        total_tokens: 113
      properties:
        cost:
          description: Total cost of the request in USD
          example: 0.000508
          format: double
          type: number
        input_tokens:
          description: Number of input tokens billed for this request
          example: 83
          type: integer
        output_tokens:
          description: Number of output tokens generated
          example: 30
          type: integer
        seconds:
          description: Duration of the input audio in seconds
          example: 9.2
          format: double
          type: number
        total_tokens:
          description: Total number of tokens used (input + output)
          example: 113
          type: integer
      type: object
    STTWord:
      description: >-
        A timestamped word, returned when the provider includes word-level
        timestamps
      example:
        confidence: 0.98
        end: 0.4
        speaker: 0
        start: 0
        word: Hello
      properties:
        channel:
          description: >-
            Zero-based audio channel index for the word, present when the
            provider transcribes channels separately
          example: 0
          type: integer
        confidence:
          description: >-
            Provider confidence for the word from 0 to 1, present when the
            provider returns per-word confidence
          example: 0.98
          format: double
          type: number
        end:
          description: Word end time in seconds
          example: 0.4
          format: double
          type: number
        speaker:
          description: >-
            Speaker index for the word, present when the provider returns
            diarization data
          example: 0
          type: integer
        speaker_label:
          description: >-
            Provider speaker label for the word, present when the provider
            labels speakers with a string
          example: speaker_0
          type: string
        start:
          description: Word start time in seconds
          example: 0
          format: double
          type: number
        type:
          description: >-
            Kind of entry; omitted or "word" for spoken words, "audio_event" for
            non-speech sounds the provider tags with timestamps
          enum:
            - word
            - audio_event
          example: word
          type: string
          x-speakeasy-unknown-values: allow
        word:
          description: >-
            The transcribed word, or the event tag such as "(laughter)" when
            type is audio_event
          example: Hello
          type: string
      required:
        - word
        - start
        - end
      type: object
    BadRequestResponseErrorData:
      description: Error data for BadRequestResponse
      example:
        code: 400
        message: Invalid request parameters
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 400.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    UnauthorizedResponseErrorData:
      description: Error data for UnauthorizedResponse
      example:
        code: 401
        message: Missing Authentication header
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 401.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    PaymentRequiredResponseErrorData:
      description: Error data for PaymentRequiredResponse
      example:
        code: 402
        message: Insufficient credits. Add more using https://openrouter.ai/credits
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 402.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ForbiddenResponseErrorData:
      description: Error data for ForbiddenResponse
      example:
        code: 403
        message: Only management keys can perform this operation
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 403.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    NotFoundResponseErrorData:
      description: Error data for NotFoundResponse
      example:
        code: 404
        message: Resource not found
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 404.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    PayloadTooLargeResponseErrorData:
      description: Error data for PayloadTooLargeResponse
      example:
        code: 413
        message: Request payload too large
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 413.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    TooManyRequestsResponseErrorData:
      description: Error data for TooManyRequestsResponse
      example:
        code: 429
        message: Rate limit exceeded
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 429.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    InternalServerResponseErrorData:
      description: Error data for InternalServerResponse
      example:
        code: 500
        message: Internal Server Error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 500.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    BadGatewayResponseErrorData:
      description: Error data for BadGatewayResponse
      example:
        code: 502
        message: Provider returned error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 502.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ServiceUnavailableResponseErrorData:
      description: Error data for ServiceUnavailableResponse
      example:
        code: 503
        message: Service temporarily unavailable
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 503.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    GatewayTimeoutResponseErrorData:
      description: Error data for GatewayTimeoutResponse
      example:
        code: 504
        message: The operation was aborted due to timeout
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 504.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    EdgeNetworkTimeoutResponseErrorData:
      description: Error data for EdgeNetworkTimeoutResponse
      example:
        code: 524
        message: Request timed out. Please try again later.
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 524.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    ProviderOverloadedResponseErrorData:
      description: Error data for ProviderOverloadedResponse
      example:
        code: 529
        message: Provider returned error
      properties:
        code:
          type: integer
          description: 'HTTP status of the error, the same as the response''s: 529.'
        message:
          type: string
          description: >-
            What went wrong, in words for a person; do not parse it, branch on
            code instead.
        metadata:
          additionalProperties: {}
          type:
            - object
            - 'null'
          description: Extra detail about the error.
      required:
        - code
        - message
      type: object
    STTInlineInputAudio:
      additionalProperties: false
      description: Inline base64 audio input for speech-to-text
      example:
        data: UklGRiQA...
        format: wav
      properties:
        data:
          description: Base64-encoded audio data (raw bytes, not a data URI)
          type: string
        format:
          description: >-
            Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported
            formats vary by provider. "pcm" means headerless signed 16-bit
            little-endian mono audio at 16 kHz.
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9+._-]{0,15}$
          type: string
      required:
        - data
        - format
      type: object
    STTUrlInputAudio:
      additionalProperties: false
      description: Audio input fetched by the provider from a URL
      example:
        format: mp3
        url: https://example.com/meeting.mp3
      properties:
        format:
          description: >-
            Audio format of the file at the URL. Defaults to the extension of
            the URL path; required when the path has no extension.
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9+._-]{0,15}$
          type: string
        url:
          description: >-
            Publicly reachable http(s) URL of the audio file. The provider
            downloads it directly, so the inline upload size limit does not
            apply. Only supported by some providers.
          format: uri
          maxLength: 8000
          type: string
      required:
        - url
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A Nemonist key (sk-nm-...) as a bearer token in the Authorization
        header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.