Generate text-to-speech for a given message

POST /api/v11/tts

Given a message ID, generate a WAV file using our text-to-speech model according to the user's set preference for TTS character. This is most useful for AI character text responses.

application/json

Body

Responses

  • 200 application/json

    text-to-speech generation completed successfully.

    Hide response attribute Show response attribute object
    • success boolean Required

      Default value is true.
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is false.

    • error string Required

      Value is One or more API parameters are malformed. Please check your request and try again.
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is false.

    • error string Required

      Value is Invalid username, password, or access token.
  • 429 application/json

    User exceeded the message limit for their current plan

    One of:
    object-2 object object-2 object
POST /api/v11/tts 
curl \
 -X POST https://chat-api.aurora-interactive.online:8443/api/v11/tts \
 -H "Content-Type: application/json" \
 -H "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 -d '{"messageId":42}'
Request examples 
# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "messageId": 42
}
Response examples (200) 
{
  "success": true
}
Response examples (400) 
{
  "success": false,
  "error": "One or more API parameters are malformed. Please check your request and try again"
}
Response examples (401) 
{
  "success": false,
  "error": "Invalid username, password, or access token"
}
Response examples (429) 
{
  "success": false,
  "error": "You have exceeded your Message/TTS quota. To send more messages, please upgrade your plan or wait until your subscription renews."
}
{
  "statusCode": 42,
  "error": "string",
  "message": "string"
}