Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-2638658.5 KB
Video

Create talking avatar video

Create a video with talking avatar using script or audio input. Either provide a script for text-to-speech or upload an audio file.

post/v2/create_video_from_avatar

Request body

aspect_ratio'portrait' | 'landscape' | 'square' required

Aspect ratio of the output video

screen_style1 | 2 | 3 required

Background style:

  • 1 - Full screen
  • 2 - Split screen
  • 3 - Picture in picture
captionboolean

Enable or disable subtitles

webhook_urlstring uri

Webhook URL for status notifications

video_namestring

Custom name for the video

Example request

{
  "avatar": {
    "avatar_id": 81
  },
  "voice": {
    "type": "script",
    "script": "Hi, welcome to JoggAI and create longer videos with Talking Avatars in minutes!",
    "audio_url": "https://res.jogg.ai/audio.mp3",
    "voice_id": "en-US-ChristopherNeural"
  },
  "aspect_ratio": "portrait",
  "screen_style": 1,
  "caption": true,
  "webhook_url": "https://example.com/webhook",
  "video_name": "My Talking Avatar Video"
}

Response

Success

codeinteger 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
msgstring required

Response message

Example response

{
  "msg": "Success",
  "data": {
    "video_id": "video_123456"
  }
}