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": "16x9",
  "green_screen": true,
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "no_caption": true,
  "no_music": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "background_asset_image_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "text": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "aspect_ratio": "16x9",
  "green_screen": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "is_hidden": true,
  "audio_url": "<string>",
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preview": "<string>",
  "preview_audio": "<string>",
  "no_caption": true,
  "no_music": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "background_asset_image_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
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Body

Response

201 - application/json

The response is of type object.