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

# Convert Audio to Text

> **Available for**: Chatflow, Workflow, Chatbot, Agent, Text Generator apps.

Transcribes an uploaded audio file to text using the app's configured speech-to-text model.



## OpenAPI

````yaml /en/3.11.x/develop/api/openapi_service.json post /audio-to-text
openapi: 3.0.1
info:
  title: Dify Service API
  description: >-
    REST API for Dify applications and knowledge bases. Application endpoints
    authenticate with an app API key; knowledge endpoints authenticate with a
    dataset API key.
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: >-
      Base URL of the Dify Service API. Replace it with your deployment's API
      endpoint.
    variables:
      api_base_url:
        default: api.example.com/v1
        description: Host and path of the API base URL, without the `https://` prefix.
security:
  - ApiKeyAuth: []
tags:
  - name: Chat Messages
    description: Operations related to chat messages and interactions.
  - name: Files
    description: File upload and preview operations.
  - name: End Users
    description: Operations related to end user information.
  - name: Feedback
    description: User feedback operations.
  - name: Conversations
    description: Operations related to managing conversations.
  - name: Audio
    description: Text-to-Speech and Speech-to-Text operations.
  - name: Applications
    description: Operations to retrieve application settings and information.
  - name: Annotations
    description: Operations related to managing annotations for direct replies.
  - name: Human Input
    description: Endpoints for resuming paused workflows that require human input.
  - name: Workflow Runs
    description: Operations for executing and managing workflows.
  - name: Completion Messages
    description: Operations related to text generation and completion.
  - name: Knowledge Bases
    description: >-
      Operations for managing knowledge bases, including creation,
      configuration, and retrieval.
  - name: Documents
    description: >-
      Operations for creating, updating, and managing documents within a
      knowledge base.
  - name: Chunks
    description: Operations for managing document chunks and child chunks.
  - name: Metadata
    description: >-
      Operations for managing knowledge base metadata fields and document
      metadata values.
  - name: Tags
    description: Operations for managing knowledge base tags and tag bindings.
  - name: Models
    description: Operations for retrieving available models.
  - name: Knowledge Pipeline
    description: >-
      Operations for managing and running knowledge pipelines, including
      datasource plugins and pipeline execution.
paths:
  /audio-to-text:
    post:
      tags:
        - Audio
      summary: Convert Audio to Text
      description: >-
        **Available for**: Chatflow, Workflow, Chatbot, Agent, Text Generator
        apps.


        Transcribes an uploaded audio file to text using the app's configured
        speech-to-text model.
      operationId: audioToText
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AudioToTextRequest'
      responses:
        '200':
          description: Successfully converted audio to text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudioToTextResponse'
              examples:
                audioToTextSuccess:
                  summary: Response Example
                  value:
                    text: >-
                      Hello, I would like to know more about the iPhone 13 Pro
                      Max.
        '400':
          description: >-
            - `app_unavailable` : The app is unavailable or misconfigured.

            - `invalid_param` : Speech-to-text is not enabled for this app.

            - `provider_not_support_speech_to_text` : The model provider does
            not support speech-to-text.

            - `provider_not_initialize` : No valid model provider credentials
            are configured.

            - `completion_request_error` : The speech recognition request
            failed.
          content:
            application/json:
              examples:
                app_unavailable:
                  summary: app_unavailable
                  value:
                    status: 400
                    code: app_unavailable
                    message: App unavailable, please check your app configurations.
                invalid_param:
                  summary: invalid_param
                  value:
                    status: 400
                    code: invalid_param
                    message: Speech to text is not enabled
                provider_not_support_speech_to_text:
                  summary: provider_not_support_speech_to_text
                  value:
                    status: 400
                    code: provider_not_support_speech_to_text
                    message: Provider not support speech to text.
                provider_not_initialize:
                  summary: provider_not_initialize
                  value:
                    status: 400
                    code: provider_not_initialize
                    message: >-
                      No valid model provider credentials found. Please go to
                      Settings -> Model Provider to complete your provider
                      credentials.
                completion_request_error:
                  summary: completion_request_error
                  value:
                    status: 400
                    code: completion_request_error
                    message: Completion request failed.
        '413':
          description: '`audio_too_large` : The audio file exceeds the `30 MB` size limit.'
          content:
            application/json:
              examples:
                audio_too_large:
                  summary: audio_too_large
                  value:
                    status: 413
                    code: audio_too_large
                    message: Audio size larger than 30 mb
        '415':
          description: >-
            `unsupported_audio_type` : The file's MIME type is not one of the
            accepted audio types (see the `file` field).
          content:
            application/json:
              examples:
                unsupported_audio_type:
                  summary: unsupported_audio_type
                  value:
                    status: 415
                    code: unsupported_audio_type
                    message: Audio type not allowed.
        '500':
          description: '`internal_server_error` : Internal server error.'
          content:
            application/json:
              examples:
                internal_server_error:
                  summary: internal_server_error
                  value:
                    status: 500
                    code: internal_server_error
                    message: >-
                      The server encountered an internal error and was unable to
                      complete your request. Either the server is overloaded or
                      there is an error in the application.
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request POST \
              --url 'https://{api_base_url}/audio-to-text' \
              --header 'Authorization: Bearer {api_key}' \
              --form 'file=@meeting-question.mp3' \
              --form 'user={user}'
components:
  schemas:
    AudioToTextRequest:
      type: object
      description: Request body for audio-to-text conversion.
      required:
        - file
      properties:
        file:
          type: string
          format: binary
          description: >-
            Audio file to transcribe. Accepted MIME types: `audio/mp3`,
            `audio/m4a`, `audio/wav`, `audio/amr`, `audio/mpga`. Other types,
            including the common `audio/mpeg`, are rejected with
            `unsupported_audio_type`. Maximum size `30 MB`.
        user:
          type: string
          description: >-
            End-user identifier, defined by your app and unique within it. See
            [End User
            Identity](/en/3.11.x/develop/api/guides/end-user-identity).
    AudioToTextResponse:
      type: object
      properties:
        text:
          type: string
          description: Output text from speech recognition.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        Every request authenticates with an API key: `Authorization: Bearer
        {API_KEY}`. App endpoints take an app API key; knowledge endpoints take
        a knowledge base API key ([Get
        Started](/en/3.11.x/develop/api/guides/get-started)).


        Keep keys server-side; never embed them in client code. Requests with a
        missing or invalid key fail with HTTP `401` (`unauthorized`).

````