Skip to main content
POST
Generate Video from Product
Generate a product marketing video from product information. This endpoint creates videos with AI-generated scripts based on your product details.

Example Usage

URL to Video Guide

Learn the complete product video workflow

Create Product

First create a product from URL

Authorizations

x-api-key
string
header
required

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

Body

application/json
product_id
string
required

Product ID from product creation

Example:

"NTIzMzc0NjI5"

video_spec
object
required

Video specification settings

avatar
object
required

Avatar configuration

voice
object
required

Voice configuration

audio
object
required

Audio configuration

script
object
required

Script configuration

visual_style
string

Visual style name from visual list

Example:

"Simple Product Switch"

override_script
string

Override the auto-generated script

webhook_url
string<uri>

Webhook URL for status notifications

Example:

"https://example.com/webhook"

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