Create an AI Avatar v2 task

API that converts a list of texts, voices and avatars to vivid videos of many people speaking. Creating a video through this endpoint costs 5 credits for every 30 seconds.

POST /api/lipsyncs_v2

cURL

cURL

curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs_v2/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "video_inputs": [
    {
      "character": {
        "type": "avatar",
        "avatar_id": "<string>",
        "offset": {
          "x": 0,
          "y": 0
        },
        "scale": 1,
        "avatar_style": "normal",
        "hidden": false
      },
      "voice": {
        "type": "text",
        "input_text": "<string>",
        "voice_id": "<string>",
        "duration": 50.5,
        "volume": 0.8
      },
      "background": {
        "type": "image",
        "url": "<string>",
        "fit": "crop",
        "effect": "imageSlideLeft"
      },
      "caption_setting": {
        "style": "normal-black",
        "offset": {
          "x": 0,
          "y": 0.4
        },
        "font_family": "Montserrat",
        "font_size": 70,
        "font_style": null,
        "background_color": null,
        "text_color": null,
        "highlight_text_color": null,
        "max_width": null,
        "line_height": null,
        "text_shadow": null,
        "hidden": false,
        "override_visual_style": false
      },
      "transition_effect": {
        "transition_in": null,
        "transition_out": null
      },
      "visual_style": "FullAvatar",
      "cta": {
        "cta_background_blur": false,
        "transition_effect": {
          "transition_in": null,
          "transition_out": null
        }
      }
    }
  ],
  "aspect_ratio": "9x16",
  "background_music": {
    "url": "<string>",
    "volume": 0.2
  },
  "webhook_url": "<string>",
  "name": "<string>",
  "model_version": "standard"
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "status": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "aspect_ratio": "16x9",
  "video_inputs": [
    "<unknown>"
  ],
  "name": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook_url": "<string>",
  "model_version": "standard"
}

About Request Data Structure of Webhook

When the ‘create an AI Avatar 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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

video_inputs · object[] · required

Show child attributes

aspect_ratio · enum<string> · default: 9x16

• 9x16 - 9X16
• 16x9 - 16X9
• 1x1 - 1X1

Available options: 9x16, 16x9, 1x1

background_music · object

Background music settings.

Show child attributes

cta_end · object

Call To Action setting to the end of video.

Show child attributes

webhook_url · string<uri>

name · string

The name of the lipsync request.

Maximum string length: 255

model_version · enum<string> · default: standard

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

• standard - Standard
• aurora_v1 - Aurora v1
• aurora_v1_fast - Aurora v1 Fast

Available options: standard, aurora_v1, aurora_v1_fast

Response

201 - application/json

id · string<uuid> · required · read-only

output · string | null · required · read-only

Output video

video_thumbnail · string<uri> · required · read-only

Generated Video Thumbnail URL

created_at · string<date-time> · required · read-only

updated_at · string<date-time> · required · read-only

credits_used · integer · required · read-only

Credits used in this API call

duration · integer · required · read-only

Duration of the video in seconds

progress · string · required · read-only

failed_reason · string | null · required · read-only

The reason for failure, if the lipsync request failed

status · string · required · read-only

Status of the lipsync request

preview · string | null · required · read-only

Preview video

editor_url · string | null · required · read-only

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled.

aspect_ratio · enum<string> · required

The aspect ratio of the video

• 16x9 - Ratio 16 9
• 1x1 - Ratio 1 1
• 9x16 - Ratio 9 16

Available options: 16x9, 1x1, 9x16

video_inputs · any[] · required · read-only

name · string | null

The name of the lipsync request.

Maximum string length: 255

media_job · string<uuid> | null

The media job associated with the lipsync request.

webhook_url · string<uri> | null

The webhook URL to be called upon completion of the lipsync request

Maximum string length: 200

model_version · enum<string>

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

• standard - Standard
• aurora_v1 - Aurora v1
• aurora_v1_fast - Aurora v1 Fast

Available options: standard, aurora_v1, aurora_v1_fast