text_to_speech

POST /api/text_to_speech/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Request body

idstring uuid required
scriptstring required

Text to be converted to speech

accentstring uuid nullable

Accent to be used for the speech

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

outputstring required

Output audio url

media_jobstring nullable required
credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

is_hiddenboolean required

Whether the job is hidden or not

statusstring required
failed_reasonstring required

Failed reason

created_atstring date-time required
updated_atstring date-time required

Response

idstring uuid required
scriptstring required

Text to be converted to speech

accentstring uuid nullable

Accent to be used for the speech

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

outputstring required

Output audio url

media_jobstring nullable required
credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

is_hiddenboolean required

Whether the job is hidden or not

statusstring required
failed_reasonstring required

Failed reason

created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status