POST
/
create_video_from_talking_avatar

Authorizations

x-api-key
string
header
required

Body

application/json
avatar_id
integer
required

ID of the avatar to use

avatar_type
enum<integer>
required

Source type of the avatar. 0: jogg avatar, 1: your avatar

Available options:
0,
1
screen_style
enum<integer>
required

Background style. 1: with background, 2: green screen, 3: webm

Available options:
1,
2,
3
voice_id
string
required

ID of the text-to-speech voice to use

aspect_ratio
enum<integer>

Aspect ratio of the output video. 0: [9:16], 1: [16:9], 2: [1:1]

Available options:
0,
1,
2
audio_url
string

Url for Audio, either script or audio_url must be provided, but not both.

caption
boolean

Subtitle option. true: enable subtitles, false: disable subtitles

script
string

Script content for the avatar to speak. Must provide either script or audio_script

Response

200 - application/json
code
integer
required

Business status code:

  • 0 - Success

  • 10104 - Record not found

  • 10105 - Invalid API key

  • 18020 - Insufficient credit

  • 18025 - No permission to call APIs.

  • 40000 - Parameter error

  • 50000 - System error

msg
string
required

Response message

data
object