Fix audio response format documentation in APIDOCS.md #1935
Conversation
Updated the documentation for the text-to-speech POST endpoint to correctly show that: - The response is a JSON structure containing base64-encoded audio data (not a raw audio file) - Added link to OpenAI audio documentation for detailed usage guidance - Fixed curl example to show how to extract audio data from the JSON response - Updated Python example to correctly parse the JSON response and extract base64-encoded audio - Updated JavaScript example to handle the JSON structure and convert base64 to playable audio Closes # 1934 Mentat precommits failed. Log: https://mentat.ai/gh/pollinations/pollinations/log/c45cdf11-9045-487a-a935-18f9fb577524
✅ Deploy Preview for pollinations canceled.
|
✅ Deploy Preview for pollinations-react-hooks-docs canceled.
|
|
I've updated the documentation for the audio response format in the Text-to-Speech (POST) endpoint. The documentation previously incorrectly stated that the response would be a raw audio file, when it's actually a JSON structure containing base64-encoded audio data. Changes made:
These changes align with the actual behavior of the API and the OpenAI-compatible format described in the issue. @voodoohop Please let me know if this looks good or if additional changes are needed! |
|
@MentatBot maybe we dont need to show a curl example for extracting the base64 - curl example for get in the audio part is enough. the other example can be python or js whatever we have there already |
Removed the extraction steps from the curl example as requested in the PR feedback. The simplified example keeps the focus on the basic API request without the additional extraction steps. The Python and JavaScript examples still contain detailed instructions for handling the JSON response and extracting the audio data. Mentat precommits failed. Log: https://mentat.ai/gh/pollinations/pollinations/log/4a20cba5-3817-43e1-bd00-58f4865d9e47
|
@voodoohop I've updated the documentation as you suggested. The curl example is now simplified by removing the extraction steps, focusing just on the basic API request. The Python and JavaScript examples still contain the detailed instructions for handling the JSON response and extracting the audio data. Let me know if this looks good or if you'd like any additional changes! |
Updated the documentation for the text-to-speech POST endpoint to correctly show that:
Closes #1934
🤖 See my steps and cost here ✨