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

# Create transcription

> Transcribe audio input into text using the configured transcription model and return the result.

<Note>
  **Related guide**: Multimodal guide. See the [Multimodal guide](/ai-gateway/features/multimodal) for a walkthrough with examples.
</Note>


## OpenAPI

````yaml post /v2/router/audio/transcriptions
openapi: 3.1.0
info:
  title: orq.ai API
  version: '2.0'
  description: orq.ai API documentation
servers:
  - url: https://my.orq.ai
security:
  - ApiKey: []
tags:
  - name: Chunking
    description: Split text into smaller chunks for retrieval and generation workflows.
  - name: File Systems
    description: >-
      Create and manage persistent file systems that agents and MCP clients read
      from and write to.
  - name: Knowledge Bases
    description: Create and manage knowledge bases used by agents and retrieval workflows.
  - name: Memory Stores
    description: Create and manage memory stores, memories, and memory documents.
  - name: Evals
    description: Run an evaluator against a conversation and its result
  - name: Logs
    description: >-
      OpenTelemetry log query API. Search, filter, aggregate, and facet log
      records ingested via OTLP.
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
  - name: Traces
    description: >-
      Query and inspect ingested trace data: search trace summaries, aggregate
      metrics, and read individual traces and their spans.
  - description: List models available through the AI Router.
    name: Models
  - name: Policies
  - name: Alerts
    description: >-
      Alerts evaluate a Reporting API metric on a fixed interval and fire
      notifications through notifiers when the value breaches a threshold. Each
      breach opens a trigger that tracks the incident until the value recovers.
  - name: Annotation Queues
    description: Annotation queues collect spans for human review.
  - name: API keys
    description: >-
      API keys authenticate programmatic access to the workspace. They expose
      opaque tokens, per-domain access grants, and budget and rate-limit
      constraints.
  - name: Audit Logs
    description: Audit logs record workspace entity changes and access-relevant events.
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, API key, provider, and model. Every
      applicable budget is enforced, and the most restrictive limit applies per
      dimension.
  - name: Files
    description: File upload and retrieval operations.
  - name: Guardrail Rules
    description: >-
      Guardrail Rules conditionally enforce evaluators and plugins for AI
      Gateway traffic. Rules may be scoped to a project or the whole workspace.
  - name: Hub
    description: Hub items are reusable templates available to a workspace.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Management keys
    description: >-
      Management keys are workspace-scoped credentials that authenticate
      programmatic access to workspace administration surfaces (API keys,
      budgets). Unlike project-scoped API keys, a management key always operates
      at the workspace level.
  - name: MCP Gateway
    description: >-
      Register upstream MCP servers, discover and sync their tools, and assemble
      gateways that expose a curated tool surface to MCP clients.
  - name: Model Catalog
    description: >-
      Browse the orq.ai model catalog: every model orq offers, across every
      provider, with pricing, capabilities and benchmark data. List endpoints
      only return models that are not deprecated. This API is public, requires
      no authentication, and is rate limited to 120 requests per minute per IP.
      Responses carry a 5-minute cache-control max-age.
  - name: Notifiers
    description: Notifier destinations used to send delivery and workflow notifications.
  - name: Projects
    description: Projects organize resources within a workspace
  - name: Routing Rules
    description: >-
      Routing Rules conditionally select models and enforce request plugins for
      AI Gateway traffic. Rules are evaluated by ascending priority and may be
      scoped to a project or the whole workspace.
  - name: Threads
    description: Threads group related trace invocations and their aggregate usage
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: Smart Routers
    description: >-
      Create and manage workspace Smart Routers. A Smart Router selects a model
      from an eligible pool for each request according to a quality, balanced,
      or cost profile.
  - name: Webhooks
    description: >-
      Create and manage webhooks that deliver workspace events to external HTTPS
      endpoints.
  - name: Workspaces
    description: >-
      A workspace is the tenant. Create is called from a user session during
      onboarding; Get, List, and Update are the public management surface.
  - name: Workspace Security
    description: >-
      Workspace-level domain verification and IP allowlist controls. These
      operations are restricted to workspace administrators.
  - name: Workspace Settings
    description: >-
      Workspace-level settings managed with a workspace credential. A workspace
      is the tenant, so these settings are a singleton — there is nothing to
      create or delete, only read and update.
  - name: Responses
  - description: Run agents on a cron cadence. Minimum firing interval is 1 hour.
    name: Agent Schedules
  - name: Embeddings
  - name: Telemetry
    description: >-
      Unified query envelope for traces, metrics, and logs. One request shape,
      one filter dialect, and one response shape per source, validated by a
      per-source registry.
  - description: Beta. Run typed classification questions against a classify model.
    name: Classify
  - description: Search Gateway with managed credits or BYOK.
    name: Web Search
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/router/audio/transcriptions:
    post:
      tags:
        - Audio
      summary: Create transcription
      description: >-
        Transcribe audio input into text using the configured transcription
        model and return the result.
      operationId: createTranscription
      requestBody:
        required: true
        description: Transcribes audio into the input language.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                model:
                  type: string
                  description: ID of the model to use
                prompt:
                  type: string
                  description: >-
                    An optional text to guide the model's style or continue a
                    previous audio segment. The prompt should match the audio
                    language.
                enable_logging:
                  type: boolean
                  default: true
                  description: >-
                    When enable_logging is set to false, zero retention mode is
                    used. This disables history features like request stitching
                    and is only available to enterprise customers.
                diarize:
                  type: boolean
                  default: false
                  description: >-
                    Whether to annotate which speaker is currently talking in
                    the uploaded file.
                response_format:
                  type: string
                  enum:
                    - json
                    - text
                    - srt
                    - verbose_json
                    - vtt
                  description: >-
                    The format of the transcript output, in one of these
                    options: json, text, srt, verbose_json, or vtt.
                tag_audio_events:
                  type: boolean
                  default: true
                  description: >-
                    Whether to tag audio events like (laughter), (footsteps),
                    etc. in the transcription.
                num_speakers:
                  type: number
                  description: >-
                    The maximum amount of speakers talking in the uploaded file.
                    Helps with predicting who speaks when, the maximum is 32. 
                timestamps_granularity:
                  type: string
                  enum:
                    - none
                    - word
                    - character
                  default: word
                  description: >-
                    The granularity of the timestamps in the transcription. Word
                    provides word-level timestamps and character provides
                    character-level timestamps per word.
                temperature:
                  type: number
                  example: 0.5
                  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.
                    If set to 0, the model will use log probability to
                    automatically increase the temperature until certain
                    thresholds are hit.
                language:
                  type: string
                  description: >-
                    The language of the input audio. Supplying the input
                    language in ISO-639-1 format will improve accuracy and
                    latency.
                timestamp_granularities:
                  type: array
                  items:
                    type: string
                    enum:
                      - word
                      - segment
                  description: >-
                    The timestamp granularities to populate for this
                    transcription. response_format must be set to verbose_json
                    to use timestamp granularities. Either or both of these
                    options are supported: "word" or "segment". Note: There is
                    no additional latency for segment timestamps, but generating
                    word timestamps incurs additional latency.
                  example:
                    - word
                    - segment
                name:
                  description: >-
                    The name to display on the trace. If not specified, the
                    default system name will be used.
                  type: string
                fallbacks:
                  type: array
                  items:
                    type: object
                    properties:
                      model:
                        type: string
                        description: Fallback model identifier
                    required:
                      - model
                  description: Array of fallback models to use if primary model fails
                retry:
                  type: object
                  properties:
                    count:
                      type: number
                      minimum: 1
                      maximum: 5
                      default: 3
                      description: Number of retry attempts (1-5)
                      example: 3
                    on_codes:
                      type: array
                      items:
                        type: number
                        minimum: 100
                        maximum: 599
                      minItems: 1
                      description: HTTP status codes that trigger retry logic
                      example:
                        - 429
                        - 500
                        - 502
                        - 503
                        - 504
                  description: Retry configuration for the request
                load_balancer:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - weight_based
                        models:
                          type: array
                          items:
                            type: object
                            properties:
                              model:
                                type: string
                                description: Model identifier for load balancing
                                example: openai/gpt-5.6-sol
                              weight:
                                type: number
                                minimum: 0.001
                                maximum: 1
                                default: 0.5
                                description: >-
                                  Weight assigned to this model for load
                                  balancing
                                example: 0.7
                            required:
                              - model
                      required:
                        - type
                        - models
                  description: Load balancer configuration for the request.
                timeout:
                  type: object
                  properties:
                    call_timeout:
                      type: number
                      minimum: 1
                      description: Timeout value in milliseconds
                      example: 30000
                  required:
                    - call_timeout
                  description: >-
                    Timeout configuration to apply to the request. If the
                    request exceeds the timeout, it will be retried or fallback
                    to the next model if configured.
                orq:
                  type: object
                  properties:
                    name:
                      description: >-
                        The name to display on the trace. If not specified, the
                        default system name will be used.
                      type: string
                    fallbacks:
                      type: array
                      items:
                        type: object
                        properties:
                          model:
                            type: string
                            description: Fallback model identifier
                            example: openai/gpt-5.4-mini
                        required:
                          - model
                      description: Array of fallback models to use if primary model fails
                    retry:
                      type: object
                      properties:
                        count:
                          type: number
                          minimum: 1
                          maximum: 5
                          default: 3
                          description: Number of retry attempts (1-5)
                          example: 3
                        on_codes:
                          type: array
                          items:
                            type: number
                            minimum: 100
                            maximum: 599
                          minItems: 1
                          description: HTTP status codes that trigger retry logic
                          example:
                            - 429
                            - 500
                            - 502
                            - 503
                            - 504
                      description: Retry configuration for the request
                    identity:
                      $ref: '#/components/schemas/PublicIdentity'
                    contact:
                      $ref: '#/components/schemas/PublicContact'
                    load_balancer:
                      oneOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - weight_based
                            models:
                              type: array
                              items:
                                type: object
                                properties:
                                  model:
                                    type: string
                                    description: Model identifier for load balancing
                                    example: openai/gpt-5.6-sol
                                  weight:
                                    type: number
                                    minimum: 0.001
                                    maximum: 1
                                    default: 0.5
                                    description: >-
                                      Weight assigned to this model for load
                                      balancing
                                    example: 0.7
                                required:
                                  - model
                          required:
                            - type
                            - models
                      description: Load balancer configuration for the request.
                      example:
                        type: weight_based
                        models:
                          - model: openai/gpt-4o
                            weight: 0.7
                          - model: anthropic/claude-3-5-sonnet
                            weight: 0.3
                    timeout:
                      type: object
                      properties:
                        call_timeout:
                          type: number
                          minimum: 1
                          description: Timeout value in milliseconds
                          example: 30000
                      required:
                        - call_timeout
                      description: >-
                        Timeout configuration to apply to the request. If the
                        request exceeds the timeout, it will be retried or
                        fallback to the next model if configured.
                file:
                  type: string
                  description: >-
                    The audio file object (not file name) to transcribe, in one
                    of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav,
                    or webm.
                  format: binary
              required:
                - model
      responses:
        '200':
          description: Returns the transcription or verbose transcription
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      text:
                        type: string
                    required:
                      - text
                  - type: object
                    properties:
                      task:
                        type: string
                      language:
                        type: string
                      duration:
                        type: number
                      text:
                        type: string
                      words:
                        type: array
                        items:
                          type: object
                          properties:
                            word:
                              type: string
                            start:
                              type: number
                            end:
                              type: number
                      segments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            seek:
                              type: number
                            start:
                              type: number
                            end:
                              type: number
                            text:
                              type: string
                            tokens:
                              type: array
                              items:
                                type: number
                            temperature:
                              type: number
                            avg_logprob:
                              type: number
                            compression_ratio:
                              type: number
                            no_speech_prob:
                              type: number
                          required:
                            - id
                            - seek
                            - start
                            - end
                            - text
                            - tokens
                            - temperature
                            - avg_logprob
                            - compression_ratio
                            - no_speech_prob
                    required:
                      - text
                  - type: string
        '422':
          description: Returns validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                      param:
                        type:
                          - string
                          - 'null'
                      code:
                        type: string
                    required:
                      - message
                      - type
                      - param
                      - code
                required:
                  - error
components:
  schemas:
    PublicIdentity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the contact
          example: contact_01ARZ3NDEKTSV4RRFFQ69G5FAV
        display_name:
          type: string
          description: Display name of the contact
          example: Jane Doe
        email:
          type: string
          format: email
          description: Email address of the contact
          example: jane.doe@example.com
        metadata:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: >-
            A hash of key/value pairs containing any other data about the
            contact
          example:
            - department: Engineering
              role: Senior Developer
        logo_url:
          type: string
          description: URL to the contact's avatar or logo
          example: https://example.com/avatars/jane-doe.jpg
        tags:
          type: array
          items:
            type: string
          description: A list of tags associated with the contact
          example:
            - hr
            - engineering
      required:
        - id
      description: >-
        Information about the identity making the request. If the identity does
        not exist, it will be created automatically.
    PublicContact:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the contact
          example: contact_01ARZ3NDEKTSV4RRFFQ69G5FAV
        display_name:
          type: string
          description: Display name of the contact
          example: Jane Doe
        email:
          type: string
          format: email
          description: Email address of the contact
          example: jane.doe@example.com
        metadata:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: >-
            A hash of key/value pairs containing any other data about the
            contact
          example:
            - department: Engineering
              role: Senior Developer
        logo_url:
          type: string
          description: URL to the contact's avatar or logo
          example: https://example.com/avatars/jane-doe.jpg
        tags:
          type: array
          items:
            type: string
          description: A list of tags associated with the contact
          example:
            - hr
            - engineering
      required:
        - id
      description: >-
        @deprecated Use identity instead. Information about the contact making
        the request.
      deprecated: true
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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