> ## Documentation index
> Fetch the complete documentation index at: https://dify-docs.docs7.io/llms.txt
> Ask it with GET https://dify-docs.docs7.io/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.

# 语音转文字

> **适用于**：Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。

使用工作空间的默认语音转文字模型，将上传的音频文件转写为文字。

`POST /audio-to-text`

## OpenAPI

````yaml zh/api-reference/openapi_service.json post /audio-to-text
openapi: 3.0.1
info:
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  title: Dify 服务 API
  version: 1.0.0
servers:
  - description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。
    url: https://{api_base_url}
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - description: 与聊天消息和交互相关的操作。
    name: 对话消息
  - description: 文件上传和预览操作。
    name: 文件操作
  - description: 终端用户信息相关操作。
    name: 终端用户
  - description: 用户反馈操作。
    name: 消息反馈
  - description: 与管理会话相关的操作。
    name: 会话管理
  - description: 文字转语音和语音转文字操作。
    name: 语音与文字转换
  - description: 获取应用设置和信息的操作。
    name: 应用配置
  - description: 与管理标注直接回复相关的操作。
    name: 标注管理
  - description: 暂停等待人工输入的工作流恢复操作。
    name: 人工介入
  - description: 用于执行和管理工作流的操作。
    name: 工作流运行
  - description: 文本生成相关操作。
    name: 文本生成消息
  - description: 用于管理知识库的操作，包括创建、配置和检索。
    name: 知识库
  - description: 用于在知识库中创建、更新和管理文档的操作。
    name: 文档
  - description: 用于管理分段和子分段的操作。
    name: 分段
  - description: 用于管理知识库元数据字段和文档元数据值的操作。
    name: 元数据
  - description: 用于管理知识库标签和标签绑定的操作。
    name: 标签
  - description: 用于获取可用模型的操作。
    name: 模型
  - description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
    name: 知识流水线
paths:
  /audio-to-text:
    post:
      description: |-
        **适用于**：Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。

        使用工作空间的默认语音转文字模型，将上传的音频文件转写为文字。
      operationId: basicChatAudioToTextCn
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/AudioToTextRequest"
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                audioToTextSuccess:
                  summary: 响应示例
                  value:
                    text: Hello, I would like to know more about the iPhone 13 Pro Max.
              schema:
                $ref: "#/components/schemas/AudioToTextResponse"
          description: 语音转文字成功。
        "400":
          content:
            application/json:
              examples:
                completion_request_error:
                  summary: completion_request_error
                  value:
                    code: completion_request_error
                    message: "[OpenAI] Incorrect model credentials provided, please check and try
                      again."
                    status: 400
                invalid_param:
                  summary: invalid_param
                  value:
                    code: invalid_param
                    message: Model whisper-1 is disabled.
                    status: 400
                model_currently_not_support:
                  summary: model_currently_not_support
                  value:
                    code: model_currently_not_support
                    message: Dify Hosted OpenAI trial currently not support the GPT-4 model.
                    status: 400
                no_audio_uploaded:
                  summary: no_audio_uploaded
                  value:
                    code: no_audio_uploaded
                    message: Please upload your audio.
                    status: 400
                provider_not_initialize:
                  summary: provider_not_initialize
                  value:
                    code: provider_not_initialize
                    message: Default model not found for speech2text
                    status: 400
                speech_to_text_disabled:
                  summary: speech_to_text_disabled
                  value:
                    code: speech_to_text_disabled
                    message: Speech to text is disabled.
                    status: 400
          description: >-
            - `no_audio_uploaded` : 未上传音频文件（`file` 字段缺失）。

            - `speech_to_text_disabled` : 应用已发布的配置未启用语音转文字。调用尚未发布的 Chatflow 或
            Workflow 应用也会返回此错误码。

            - `provider_not_initialize` : 工作空间没有可用的语音转文字模型，或默认语音转文字模型未配置凭据。

            - `invalid_param` : 默认语音转文字模型已在模型供应商设置中禁用，或其所属的模型供应商已卸载。

            - `model_currently_not_support` : 在 Dify Cloud 上，工作空间的付费 AI
            消息额度已用完，改用的试用额度不包含默认语音转文字模型。

            - `completion_request_error` : 模型供应商拒绝或未能完成转写请求（例如凭据无效）。
        "413":
          content:
            application/json:
              examples:
                audio_too_large:
                  summary: audio_too_large
                  value:
                    code: audio_too_large
                    message: Audio size larger than 30 mb
                    status: 413
          description: "`audio_too_large` : 音频文件超出 `30 MB` 大小限制。"
        "415":
          content:
            application/json:
              examples:
                unsupported_audio_type:
                  summary: unsupported_audio_type
                  value:
                    code: unsupported_audio_type
                    message: Audio type not allowed.
                    status: 415
          description: "`unsupported_audio_type` : 文件的 MIME 类型不在接受的音频类型之列（见 `file` 字段）。"
        "500":
          content:
            application/json:
              examples:
                internal_server_error:
                  summary: internal_server_error
                  value:
                    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.
                    status: 500
          description: "`internal_server_error` : 内部服务器错误。"
      summary: 语音转文字
      tags:
        - 语音与文字转换
      x-mint:
        href: /zh/api-reference/audio/convert-audio-to-text
        metadata:
          sidebarTitle: 语音转文字
          title: 语音转文字
components:
  schemas:
    AudioToTextRequest:
      description: 语音转文字的请求体。
      properties:
        file:
          description: 要转写的音频文件。接受的 MIME 类型：`audio/mp3`、`audio/m4a`（也接受
            `audio/x-m4a`）、`audio/wav`、`audio/amr`、`audio/mpga`。其他类型（包括常见的
            `audio/mpeg`）会返回 `unsupported_audio_type` 错误。最大 `30 MB`。
          format: binary
          type: string
        user:
          description: 终端用户标识，由你的应用定义，需在应用内唯一。参见
            [终端用户身份](/zh/api-reference/guides/end-user-identity)。
          type: string
      required:
        - file
      type: object
    AudioToTextResponse:
      properties:
        text:
          description: 语音识别输出的文字。
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: API_KEY
      description: >-
        每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API
        Key，知识库接口使用知识库 API Key（[快速开始](/zh/api-reference/guides/get-started)）。


        API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。
      scheme: bearer
      type: http
````