POST
/
create_video_from_talking_avatar
Create Talking Avatar Video
curl --request POST \
  --url https://api.jogg.ai/v1/create_video_from_talking_avatar \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "script": "Hi, welcome to JoggAI and create longer videos with Talking Avatars in minutes!",
  "audio_url": "https://res.jogg.ai/audio.mp3",
  "aspect_ratio": 0,
  "screen_style": 1,
  "avatar_id": 81,
  "avatar_type": 0,
  "voice_id": "en-US-ChristopherNeural",
  "caption": true,
  "video_name": "My Video"
}'
{
  "code": 123,
  "msg": "<string>",
  "data": {
    "project_id": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
screen_style
enum<integer>
required

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

Available options:
1,
2,
3
Example:

1

​
avatar_id
integer
required

ID of the avatar to use

Example:

81

​
avatar_type
enum<integer>
required

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

Available options:
0,
1
Example:

0

​
voice_id
string
required

ID of the text-to-speech voice to use

Example:

"en-US-ChristopherNeural"

​
script
string

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

Example:

"Hi, welcome to JoggAI and create longer videos with Talking Avatars in minutes!"

​
audio_url
string

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

Example:

"https://res.jogg.ai/audio.mp3"

​
aspect_ratio
enum<integer>

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

Available options:
0,
1,
2
Example:

0

​
caption
boolean

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

​
video_name
enum<string>

If you want to specify the name of the generated video, please use this parameter.

Example:

"My Video"

Response

200 - application/json

Success

​
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