text_to_speech left out in the API response #13972

Closed
opened 2026-02-21 19:14:50 -05:00 by yindo · 1 comment
Owner

Originally created by @yeyunwen on GitHub (May 17, 2025).

Self Checks

  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit report (我已阅读并同意 Language Policy).
  • [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)
  • Please do not modify this template :) and fill in all the required fields.

Provide a description of requested docs changes

text_to_speech is returned in /parameters, but it's not described in the API documentation.
Image
This is the content returned by /parameters in the document, and you can see that text_to_speech is not there
Image

Originally created by @yeyunwen on GitHub (May 17, 2025). ### Self Checks - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit report (我已阅读并同意 [Language Policy](https://github.com/langgenius/dify/issues/1542)). - [x] [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:) - [x] Please do not modify this template :) and fill in all the required fields. ### Provide a description of requested docs changes **text_to_speech is returned in /parameters, but it's not described in the API documentation.** <img width="824" alt="Image" src="https://github.com/user-attachments/assets/092b32be-e46e-421f-b8cd-ef8a93dbd78e" /> **This is the content returned by /parameters in the document, and you can see that text_to_speech is not there** <img width="1205" alt="Image" src="https://github.com/user-attachments/assets/b2894007-4287-4adc-b819-9344ede4512a" />
yindo added the 📚 documentationstt & tts labels 2026-02-21 19:14:50 -05:00
yindo closed this issue 2026-02-21 19:14:50 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (May 17, 2025):

Hello @yeyunwen! I'm Dosu, a bot here to help you with bugs, answer your questions, and assist you on your journey to becoming a contributor. I'm ready to assist you while we wait for a human maintainer. How can I help you today?

The text_to_speech parameter is indeed part of the API response, but it seems to be missing from the documentation. This parameter is used to facilitate the conversion of text into audio files, leveraging text-to-speech functionality. It includes settings such as enabled, autoplay, language, and voice [1][2].

To address this issue, it would be beneficial to update the API documentation to include a description of the text_to_speech parameter, detailing its purpose and the possible configurations. This will help users understand how to utilize this feature effectively within the Dify platform.

To continue talking to Dosu, mention @dosu.


Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other

@dosubot[bot] commented on GitHub (May 17, 2025): <!-- Greeting --> Hello @yeyunwen! I'm [Dosu](https://dosu.dev), a bot here to help you with bugs, answer your questions, and assist you on your journey to becoming a contributor. I'm ready to assist you while we wait for a human maintainer. How can I help you today? <!-- Answer --> The `text_to_speech` parameter is indeed part of the API response, but it seems to be missing from the documentation. This parameter is used to facilitate the conversion of text into audio files, leveraging text-to-speech functionality. It includes settings such as `enabled`, `autoplay`, `language`, and `voice` <sup>[[1]](https://github.com/langgenius/dify/blob/main/api/controllers/service_api/app/audio.py)</sup><sup>[[2]](https://github.com/langgenius/dify/blob/main/api/core/tools/builtin_tool/providers/audio/tools/tts.yaml)</sup>. To address this issue, it would be beneficial to update the API documentation to include a description of the `text_to_speech` parameter, detailing its purpose and the possible configurations. This will help users understand how to utilize this feature effectively within the Dify platform. <!-- Dosu Comment Footer --> *To continue talking to [Dosu](https://dosu.dev), mention @dosu.* --- <sup>Help Dosu learn! Give it feedback: [Great Response](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=great_response) | [Irrelevant Answer](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=irrelevant_answer) | [Incorrect Sources](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=incorrect_sources) | [Too Verbose](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=hallucination) | [Bug Report](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/ca9de0d5-e9d3-4ce1-84da-f95262d2737b?feedback_type=other)</sup>
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#13972