CRcreatify
text_to_speech

GET /api/text_to_speech/

Changed on

Retrieve a list of records. Optionally filter by ids (UUIDs) and/or a creation time window [created_after, created_before). The window selects records by when they were created; status and credits_used reflect their current state and can change until the job finishes (failed jobs are refunded and report 0 credits).

Request

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

Query parameters

created_afterstring date-time

Only return records created at or after this time (inclusive). ISO 8601, e.g. 2026-09-27T00:00:00Z or 2026-09-27T00:00:00+08:00 (URL-encode '+' as %2B). Timestamps without an offset are treated as UTC.

created_beforestring date-time

Only return records created before this time (exclusive). Same format as created_after.

idsstring

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

orderingstring

Which field to use when ordering the results.

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

  • 8423ba73b422Revision changes
    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the optional property / to the response with the status