Skip to main content
POST
/
v2
/
create_video_from_avatar
Create talking avatar video
curl --request POST \
  --url https://api.jogg.ai/v2/create_video_from_avatar \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "avatar": {
    "avatar_type": 0,
    "avatar_id": 81
  },
  "voice": {
    "type": "script",
    "voice_id": "en-US-ChristopherNeural",
    "script": "Hi, welcome to JoggAI and create longer videos with Talking Avatars in minutes!",
    "audio_url": "https://res.jogg.ai/audio.mp3"
  },
  "aspect_ratio": "portrait",
  "screen_style": 1,
  "caption": true,
  "webhook_url": "https://example.com/webhook",
  "video_name": "My Talking Avatar Video"
}
'
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.jogg.ai/llms.txt

Use this file to discover all available pages before exploring further.

Create a talking avatar video by providing a script, avatar ID, and voice ID. This endpoint generates videos with AI avatars speaking your provided text.

​
Example Usage

curl --request POST \
  --url 'https://api.jogg.ai/v2/create_video_from_avatar' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "script": "Welcome to JoggAI! Create amazing avatar videos with our API.",
    "avatar_id": 127,
    "voice_id": "en-US-ChristopherNeural",
    "aspect_ratio": 0,
    "screen_style": 0
  }'

Create Avatar Videos Guide

Learn how to create avatar videos step-by-step

Get Video Status

Check the status of your video generation

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain your key from the JoggAI dashboard.

Body

application/json
​
avatar
object
required

Avatar configuration

​
voice
object
required

Voice configuration including script or audio input

​
aspect_ratio
enum<string>
required

Aspect ratio of the output video

Available options:
portrait,
landscape,
square
Example:

"portrait"

​
screen_style
enum<integer>
required

Background style:

  • 1 - Full screen
  • 2 - Split screen
  • 3 - Picture in picture
Available options:
1,
2,
3
Example:

1

​
caption
boolean

Enable or disable subtitles

Example:

true

​
webhook_url
string<uri>

Webhook URL for status notifications

Example:

"https://example.com/webhook"

​
video_name
string

Custom name for the video

Example:

"My Talking Avatar 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
Example:

0

​
msg
string
required

Response message

Example:

"Success"

​
data
object