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

# 文字转语音

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

将文本转换为语音音频。传入 `text` 可合成任意文本，或传入 `message_id` 为已有消息的答案配音。



## OpenAPI

````yaml /zh/3.11.x/develop/api/openapi_service.json post /text-to-audio
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 API 的基础 URL。替换为你部署的 API 基础 URL。
    variables:
      api_base_url:
        default: api.example.com/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - 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: 知识流水线
    description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。
paths:
  /text-to-audio:
    post:
      tags:
        - 语音与文字转换
      summary: 文字转语音
      description: |-
        **适用于**：Chatflow、Workflow、聊天助手、Agent、文本生成应用。

        将文本转换为语音音频。传入 `text` 可合成任意文本，或传入 `message_id` 为已有消息的答案配音。
      operationId: basicChatTextToAudioCn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TextToAudioRequest'
            examples:
              textToAudioExample:
                summary: 请求示例
                value:
                  text: Hello, welcome to our service.
                  user: abc-123
                  voice: alloy
                  streaming: false
      responses:
        '200':
          description: >-
            返回生成的音频文件。`Content-Type` 头设置为音频 MIME 类型（例如
            `audio/wav`、`audio/mp3`）。当配置的 TTS 供应商返回流时，音频以 `audio/mpeg`
            分块传输编码方式返回；请求中的 `streaming` 字段不影响这一行为。
          content:
            audio/mpeg:
              schema:
                type: string
                format: binary
        '400':
          description: |-
            - `app_unavailable` : 应用不可用或配置错误。
            - `invalid_param` : 未启用文字转语音、缺少 `text` 或没有可用音色。
            - `provider_not_initialize` : 未配置有效的模型供应商凭据。
            - `completion_request_error` : 文字转语音请求失败。
          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: TTS is not enabled
                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.
        '500':
          description: '`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.
components:
  schemas:
    TextToAudioRequest:
      type: object
      description: 文字转语音的请求体。提供 `message_id` 或 `text` 其中之一。
      properties:
        message_id:
          type: string
          format: uuid
          description: >-
            要转为语音的消息答案的 ID。同时提供 `text` 时，优先使用 `message_id`。消息 ID 从
            [获取会话历史消息](/zh/3.11.x/develop/api/conversations/list-conversation-messages)
            获取。
        text:
          type: string
          description: 要合成为语音的文本。
        user:
          type: string
          description: >-
            终端用户标识，由你的应用定义，需在应用内唯一。参见
            [终端用户身份](/zh/3.11.x/develop/api/guides/end-user-identity)。
        voice:
          type: string
          description: >-
            文字转语音使用的声音。可用声音取决于为此应用配置的 TTS
            提供商。使用[获取应用参数](/zh/3.11.x/develop/api/applications/get-app-parameters)
            → `text_to_speech.voice` 中的 `voice` 值作为默认值。
        streaming:
          type: boolean
          description: 为向后兼容而保留，但不产生任何效果。音频是否以流式返回由配置的 TTS 供应商的输出决定，而非此字段。
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API
        Key，知识库接口使用知识库 API
        Key（[快速开始](/zh/3.11.x/develop/api/guides/get-started)）。


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

````