> ## 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.

> Transcribe audio files to text using the AI Router. Supports multiple audio formats and languages with automatic speech recognition models.

# Create transcription



## 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://api.orq.ai
security:
  - ApiKey: []
tags:
  - name: Guardrail Rules
  - name: Policies
  - name: Routing Rules
  - name: Files
    description: File upload and retrieval operations.
  - name: FilesService
  - name: Projects
    description: Projects organize resources within a workspace
  - name: ProjectsService
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: SkillsService
  - name: Responses
  - description: >-
      Run agents on a cadence — cron, interval, or one-off. Minimum firing
      interval is 1 hour.
    name: Agent Schedules
  - 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: ReportingService
    description: |-
      ReportingService exposes a single QueryReport RPC that maps allowlisted
       analytics payloads onto safe rollup queries. Callers never send SQL;
       the backend picks the rollup family and grain from the metric
       catalogue, the requested range, and the requested grouping.
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/router/audio/transcriptions:
    post:
      tags:
        - Audio
      summary: Create transcription
      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:
                  type: string
                  description: >-
                    The name to display on the trace. If not specified, the
                    default system name will be used.
                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
                      default:
                        - 429
                      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-4o
                              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:
                      type: string
                      description: >-
                        The name to display on the trace. If not specified, the
                        default system name will be used.
                    fallbacks:
                      type: array
                      items:
                        type: object
                        properties:
                          model:
                            type: string
                            description: Fallback model identifier
                            example: openai/gpt-4o-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
                          default:
                            - 429
                          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-4o
                                  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: Array of models with weights for load balancing requests
                      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

````