Skip to content

Get Text to Speech Task

FreshGET
GET https://api.creatify.ai/api/text_to_speech/{id}/

Retrieve a specific text-to-speech task by its ID.

Path Parameters

NameTypeRequiredDescription
idstringYesThe TTS task ID

Headers

HeaderTypeRequiredDescription
X-API-IDstringYesYour Creatify API ID
X-API-KEYstringYesYour Creatify API key

Example Request

bash
curl -X GET 'https://api.creatify.ai/api/text_to_speech/tts-001/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

json
{
  "id": "tts-001",
  "status": "done",
  "text": "Welcome to our product demonstration.",
  "voice_id": "voice-en-001",
  "output": "https://cdn.creatify.ai/tts/tts-001.mp3",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:31:00Z"
}

Response Fields

FieldTypeDescription
idstringUnique task identifier
statusstringTask status: pending, processing, done, failed
textstringThe input text
voice_idstringVoice ID used
outputstringGenerated audio URL (available when done)
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

Status Codes

CodeDescription
200Success
401Unauthorized -- invalid API credentials
404Task not found
500Internal server error