Synthesize speech from text

Convert text to speech using agent’s voice settings

POST /api/audio/{agentId}/audio-messages/synthesize

Synthesize speech from text

cURL

curl --request POST \
  --url http://localhost:3000/api/audio/{agentId}/audio-messages/synthesize \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "options": {
    "voice": "<string>",
    "language": "<string>"
  }
}
'

200

"<string>"

Path Parameters

agentId · string<uuid> · required

ID of the agent

Body

application/json

text · string · required

Text to convert to speech

options · object

Show child attributes

Response

200

audio/mpeg

Speech synthesized successfully

The response is of type file.