Roadmap

Changelog

Share Your Ideas

JoggAI API

Home

API Documentation

Get Started

Support

List of Available Webhook Events

apiKeyAuth

List webhook events

Quickly turn URLs or product assets into compelling videos, boosting website traffic and sales. Benefit from rich templates, diverse AI avatars, and swift responses for engaging content that drives success.

Welcome to JoggAI

Product Tour

Create an ultra realistic AI clone of yourself.

Instant Avatar

Getting Started

How to create avatar video with the avatars from library.

Create Avatar Videos Using Library Avatars

How to create avatar video with instant avatars.

Create Avatar Videos Using Instant Avatars

Using Audio Source as Voice

How to create transparent avatar videos in WebM/MP4 format.

Create Transparent Avatar Videos in WebM/MP4 Format

Create Video from URL

AI Scripts

How to receive notifications for various events through webhooks.

Webhook Integration Guide




Get product information by crawling the provided URL. The response contains two important IDs:



- product_id: Used in Step 2 & Step 3 for updating product information and creating the video.

Upload URL to create product

Optional step to update product details. Use the product_id received from Step 1 (POST /open/product response)

Update Product Information

Final step to generate the product video. Use the product_id received from Step 1 (POST /product response)

Generate Video from Product Information

You can generate a preview video using the product_id obtained from the Upload URL to create a product. Set the relevant video parameters to create the preview. You can obtain the preview video result using the project_id at the Get Generated Video endpoint.

Generate Preview Video from Product Information

Creates a talking avatar video with specified parameters

Create Talking Avatar Videos

Get information about a specific project using its ID.

Get Generated Video

Simply provide the product information or the product_id generated in the Upload URL to create product, and you can create several different styles of product introduction scripts.If you do not provide the product_id, then the product's name and description are required.

Generate a signed URL for file upload. Use the `sign_url` obtained here to upload your file.

Upload Media

Get a list of available avatars with specified filters

Get Avatar List from Library

Get Instant Avatar List

Retrieve a list of available voice with specified gender filter

Get Voice List from Library

Retrieve a list of your available voice with specified gender filter

Get My Voice

Get Visual Style

Get Template List from Library

Get My Template

Get Music List from JoggAI

Get a list of configured webhook endpoints

List of Webhook Endpoints

Add a Webhook Endpoint

Update an existing webhook endpoint configuration

QuickStart

API Documentation

URL to Video

Create Avatar Videos

Get Generated Video

AI Scripts

Upload Media

Avatar

Voice

Visual Style

Template

Music

Webhook

List of Available Webhook Events

Authorizations

Response