POST
/
api
/
lipsyncs
/
curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "text": "<string>",
  "audio": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aspect_ratio": "16:9",
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "text": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "aspect_ratio": "16:9",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "progress": 123,
  "failed_reason": "<string>",
  "status": "pending",
  "audio_url": "<string>",
  "webhook_url": "<string>"
}

​
About Request Data Structure of Webhook

When the ‘create a lipsync task’ interface is requested, if the ‘webhook_url’ is passed in the parameters, the program will initiate a POST request to this network address when the task succeeds or fails, with the following content:

{
    'id': 'string',
    'status': 'string',
    ’failed_reason’: 'string',
    'output': 'string',
}

Arguments:

  • id (string): The unique identifier of the job
  • status (string): The status of the job. Possible values are pending, in_queue, running, failed, done
  • failed_reason (string): The reason of the failure if the job failed
  • output (string): The URL of the video if the job is done

Authorizations

X-API-ID
string
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

name
string | null
text
string | null
audio
string | null
creator
string
required
aspect_ratio
enum<string>
  • 16:9 - Ratio 16 9
  • 1:1 - Ratio 1 1
  • 9:16 - Ratio 9 16
Available options:
16:9,
1:1,
9:16
webhook_url
string | null

Response

201 - application/json
id
string
required
name
string | null
text
string | null
creator
string
required
output
string | null
required
aspect_ratio
enum<string>
  • 16:9 - Ratio 16 9
  • 1:1 - Ratio 1 1
  • 9:16 - Ratio 9 16
Available options:
16:9,
1:1,
9:16
created_at
string
required
updated_at
string
required
progress
number
required
failed_reason
string | null
required
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
Available options:
pending,
in_queue,
running,
failed,
done
audio_url
string | null
required
webhook_url
string | null
Get link by idGet lipsync items