POST
/
preview
curl --request POST \
  --url https://api.jogg.ai/v1/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "product_id": "8xUNyTgckMBsX4jn4Lxf",
  "aspect_ratio": 0,
  "video_length": "15",
  "language": "english",
  "avatar_id": 1,
  "avatar_type": 0,
  "voice_id": "en-US-ChristopherNeural",
  "script_style": "Storytime",
  "visual_style": "Simple split screen template",
  "template_id": 0,
  "template_type": "custom",
  "override_script": "",
  "caption": true
}'
{
  "code": 123,
  "msg": "<string>",
  "data": {
    "project_id": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
product_id
string
required

Product ID obtained from Step 1 (POST /product) response data.product_id

Example:

"8xUNyTgckMBsX4jn4Lxf"

​
aspect_ratio
enum<integer>
required

Video aspect ratio:

  • 0 - Portrait [9:16]

  • 1 - Landscape [16:9]

  • 2 - Square [1:1]

Available options:
0,
1,
2
Example:

0

​
video_length
enum<string>
required

Video Length.

Available options:
15,
30,
60
Example:

"15"

​
language
enum<string>
default:english
required

Script generation language (defaults to English if not specified):

  • english - English

  • filipino - Filipino

  • french - French

  • german - German

  • hindi - Hindi

  • indonesian - Indonesian

  • italian - Italian

  • japanese - Japanese

  • korean - Korean

  • malay - Malay

  • portuguese - Portuguese

  • russian - Russian

  • spanish - Spanish

  • thai - Thai

  • vietnamese - Vietnamese

  • arabic - Arabic

  • greek - Greek

  • turkish - Turkish

  • slovenian - Slovenian

  • croatian - Croatian

  • romanian - Romanian

  • chinese - Simplified Chinese

  • bengali - Bengali

  • urdu - Urdu

  • hungarian - Hungarian

  • traditional-chinese - Traditional Chinese

  • polish - Polish

  • cantonese - Cantonese

  • danish - Danish

  • malayalam - Malayalam

  • tamil - Tamil

  • telugu - Telugu

  • czech - Czech

  • hebrew - Hebrew

  • zulu - Zulu

  • swedish - Swedish

  • lithuanian - Lithuanian

  • dutch - Dutch

  • flemish - Flemish

  • norwegian - Norwegian

  • finnish - Finnish

  • bulgarian - Bulgarian

  • latvian - Latvian

  • ukrainian - Ukrainian

  • mongolian - Mongolian

  • persian - Persian

  • odia - Odia

  • assamese - Assamese

  • kannada - Kannada

  • tagalog - Tagalog

  • amharic - Amharic

  • serbian - Serbian

  • slovak - Slovak

  • swahili - Swahili

Available options:
english,
filipino,
french,
german,
hindi,
indonesian,
italian,
japanese,
korean,
malay,
portuguese,
russian,
spanish,
thai,
vietnamese,
arabic,
greek,
turkish,
slovenian,
croatian,
romanian,
chinese,
bengali,
urdu,
hungarian,
traditional-chinese,
polish,
cantonese,
danish,
malayalam,
tamil,
telugu,
czech,
hebrew,
zulu,
swedish,
lithuanian,
dutch,
flemish,
norwegian,
finnish,
bulgarian,
latvian,
ukrainian,
mongolian,
persian,
odia,
assamese,
kannada,
tagalog,
amharic,
serbian,
slovak,
swahili
Example:

"english"

​
avatar_id
integer
required

Avatar id from Jogg Avatar or Your Avatar.

Example:

1

​
avatar_type
enum<integer>
required

Avatar source type:

  • 0 - Public avatars

  • 1 - Custom avatars

Available options:
0,
1
Example:

0

​
script_style
enum<string>
required

Script writing style for video content:

  • Don't Worry - Casual and reassuring tone

  • Storytime - Narrative and engaging storytelling approach

  • Discovery - Exploratory and revealing style

  • Data - Fact-based and analytical presentation

  • Top 3 reasons - List-based persuasive format

  • Light marketing - Soft-sell marketing approach

Available options:
Don't Worry,
Storytime,
Discovery,
Data,
Top 3 reasons,
Light marketing
Example:

"Storytime"

​
template_type
enum<string>
required

Template source type:

  • public - Template from template library

  • custom - Template from my templates

Available options:
public,
custom
Example:

"custom"

​
voice_id
string

Voice id from voice list.

Example:

"en-US-ChristopherNeural"

​
visual_style
string

Visual style of the video from visual list(GET /visual)

Example:

"Simple split screen template"

​
template_id
integer

Template ID from template library or custom template

Example:

0

​
override_script
string

You can enter the script you want to use here to override the existing script.

Example:

""

​
caption
boolean

Controls subtitle rendering:

  • true - Show subtitles

  • false - Hide subtitles

Example:

true

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