Skip to main content
GET
/
api
/
text_to_speech
/
{id}
/
cURL
curl --request GET \
  --url https://api.creatify.ai/api/text_to_speech/{id}/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "script": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook_url": "<string>",
  "output": "<string>",
  "media_job": "<string>",
  "credits_used": 123,
  "duration": 123,
  "is_hidden": true,
  "status": "<string>",
  "failed_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Text To Speech Flow.

Response

200 - application/json
​
id
string<uuid>
required
​
script
string
required

Text to be converted to speech

Maximum length: 4000
​
output
string
required

Output audio url

​
media_job
string | null
required
​
credits_used
integer
required

Credits used in this API call

​
duration
integer
required

Duration of the video in seconds

​
is_hidden
boolean
required

Whether the job is hidden or not

​
status
string
required
​
failed_reason
string
required

Failed reason

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
accent
string<uuid> | null

Accent to be used for the speech

​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200