Skip to main content

Text to Speech

The audio_tts function converts text to audio using an audio model provider.

  • Function name: extensions.com.cloud-apim.llm-extension.audio_tts

Parameters​

ParameterTypeRequiredDescription
providerstringyesThe audio model provider id
encode_base64booleannoReturn the audio as base64 encoded string (default: false)
file_outstringnoThe file path to save the generated audio (default: a temporary file)
payloadobjectyesThe payload object
payload.inputstringyesThe text to convert to speech
payload.modelstringnoThe model name
payload.voicestringnoThe voice name
payload.instructionsstringnoInstructions for the generation
payload.responseFormatstringnoThe audio response format
payload.speednumbernoThe speech speed

Output​

When encode_base64 is true:

{
"content_type": "audio/mp3",
"base64": "..."
}

When encode_base64 is false (default):

{
"content_type": "audio/mp3",
"file_out": "/tmp/audio-out-xxxxx.mp3"
}

Example​

{
"kind": "call",
"function": "extensions.com.cloud-apim.llm-extension.audio_tts",
"args": {
"provider": "audio-model_xxxxx",
"encode_base64": true,
"payload": {
"input": "Hello, world!",
"model": "tts-1",
"voice": "alloy",
"speed": 1.0
}
},
"result": "audio_result"
}