Skip to main content
GET
/
api
/
text_to_speech
cURL
curl --request GET \
  --url https://api.creatify.ai/api/text_to_speech/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "script": "<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",
    "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "webhook_url": "<string>"
  }
]

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.

Query Parameters

​
ids
string

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

Minimum string length: 1
​
ordering
string

Which field to use when ordering the results.

Response

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

Text to be converted to speech

Maximum string length: 8000
​
output
string
required
read-only

Output audio url

​
media_job
string | null
required
read-only
​
credits_used
number
required
read-only

Credits used in this API call

​
duration
integer
required
read-only

Duration of the video in seconds

​
is_hidden
boolean
required
read-only

Whether the job is hidden or not

​
status
string
required
read-only
​
failed_reason
string
required
read-only

Failed reason

​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
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 string length: 200