How to create avatar video with the avatars from library.
Welcome to the Jogg.ai API! This document will guide you on how to create a avatar video by calling our API.
Before you begin, it is crucial to understand that creating an avatar video is an asynchronous operation. This means you will not receive the final video file immediately after calling the API.
The entire process is as follows:
POST
request to Jogg.ai, containing the video script, selected avatar, and all other necessary information.200 Accepted
response, which includes a unique project_id
. This ID is your credential for tracking this task.POST
notification to your pre-configured webhook_url
, containing the video status and the final video playback address. This is the most efficient and reliable method.project_id
to periodically call the GET /project/{project_id}
endpoint to check the task status.Please refer to the Create Talking Avatar Videos for more details and refer to the next section for obtaining the avatar_id and voice_id.
Request Example:
Response example:
If you want to change the Avatar or voice, you can obtain the avatar_id
from Public Avatars List and the voice_id
from Public Voices List to make replacements.
Please refer to the Get Avatar List from Library for more details.
Parameters:
aspect_ratio
: Video aspect ratio (0: [9:16], 1: [16:9])
style
: Video preset style (professional, social)
gender
: Avatar gender(female, male)
age
: Avatar age (adult, senior, young_adult)
All query parameters are non-mandatory.
Response example:
Please refer to the Get Voice List form Library for more details.
Parameters:
gender
: Avatar gender(female, male)
language
: Filter voices by language
age
: Avatar age (young, middle_aged, old)
All query parameters are non-mandatory.
Response example:
Use the project_id obtained from the “Generate Video from Product Information” step to retrieve details about the video generation, including status and duration. Access the generated video using the video_url.
Please refer to the GetGeneratedVideo for the full options of enums.
Response example:
How to create avatar video with the avatars from library.
Welcome to the Jogg.ai API! This document will guide you on how to create a avatar video by calling our API.
Before you begin, it is crucial to understand that creating an avatar video is an asynchronous operation. This means you will not receive the final video file immediately after calling the API.
The entire process is as follows:
POST
request to Jogg.ai, containing the video script, selected avatar, and all other necessary information.200 Accepted
response, which includes a unique project_id
. This ID is your credential for tracking this task.POST
notification to your pre-configured webhook_url
, containing the video status and the final video playback address. This is the most efficient and reliable method.project_id
to periodically call the GET /project/{project_id}
endpoint to check the task status.Please refer to the Create Talking Avatar Videos for more details and refer to the next section for obtaining the avatar_id and voice_id.
Request Example:
Response example:
If you want to change the Avatar or voice, you can obtain the avatar_id
from Public Avatars List and the voice_id
from Public Voices List to make replacements.
Please refer to the Get Avatar List from Library for more details.
Parameters:
aspect_ratio
: Video aspect ratio (0: [9:16], 1: [16:9])
style
: Video preset style (professional, social)
gender
: Avatar gender(female, male)
age
: Avatar age (adult, senior, young_adult)
All query parameters are non-mandatory.
Response example:
Please refer to the Get Voice List form Library for more details.
Parameters:
gender
: Avatar gender(female, male)
language
: Filter voices by language
age
: Avatar age (young, middle_aged, old)
All query parameters are non-mandatory.
Response example:
Use the project_id obtained from the “Generate Video from Product Information” step to retrieve details about the video generation, including status and duration. Access the generated video using the video_url.
Please refer to the GetGeneratedVideo for the full options of enums.
Response example: