# JoggAI API

## Docs

- [AI Script Generation](https://docs.jogg.ai/api-reference/v2/API Documentation/AIScripts.md): Automatically generate engaging video scripts with AI
- [Avatar Videos with Transparent Background](https://docs.jogg.ai/api-reference/v2/API Documentation/AvatarVideosTransparentBackground.md): Generate avatars with transparent backgrounds for easy compositing
- [Avatar Videos with Custom Audio](https://docs.jogg.ai/api-reference/v2/API Documentation/AvatarVideosWithAudioSource.md): Use your own audio file instead of text-to-speech
- [Avatar Videos with Photo Avatars](https://docs.jogg.ai/api-reference/v2/API Documentation/AvatarVideosWithPhotoAvatar.md): Use custom photo avatars created from your own photos
- [Create Talking Avatar Videos](https://docs.jogg.ai/api-reference/v2/API Documentation/CreateAvatarVideos.md): Generate professional videos with realistic AI avatars speaking your script
- [Create Photo Avatar](https://docs.jogg.ai/api-reference/v2/API Documentation/CreatePhotoAvatar.md): Generate custom AI avatars from portrait photos
- [Create Video from Template](https://docs.jogg.ai/api-reference/v2/API Documentation/CreateVideoFromTemplate.md): Generate professional videos quickly using pre-designed templates
- [Check Video Result & Status](https://docs.jogg.ai/api-reference/v2/API Documentation/GetResult.md): Retrieve video generation status and download URLs
- [Lip Sync Video](https://docs.jogg.ai/api-reference/v2/API Documentation/LipSyncVideo.md): Create lip sync videos by combining a source video with a target audio track
- [Create Video from URL/Product](https://docs.jogg.ai/api-reference/v2/API Documentation/URLtoVideo.md): Generate marketing videos automatically from product URLs or descriptions
- [Upload Media Assets](https://docs.jogg.ai/api-reference/v2/API Documentation/UploadMedia.md): Upload images, videos, and audio files to use in your video projects
- [Video Translation](https://docs.jogg.ai/api-reference/v2/API Documentation/VideoTranslation.md): Translate videos into 40+ languages with AI-powered voiceover and subtitles
- [Webhook Integration Guide](https://docs.jogg.ai/api-reference/v2/API Documentation/WebhookIntegration.md): Receive real-time notifications when your videos are ready
- [Create AI Script](https://docs.jogg.ai/api-reference/v2/Asset/CreateAIScript.md): Generate AI-powered video script based on product information and requirements. The script generation is asynchronous - use the returned task_id to check status.
- [Get AI Script Result](https://docs.jogg.ai/api-reference/v2/Asset/GetAIScriptResult.md): Check the status and retrieve results of AI script generation task. Scripts are generated in multiple styles for variety.
- [Get Background Music](https://docs.jogg.ai/api-reference/v2/Asset/GetMusic.md): Get available background music with pagination. Supports filtering and sorting of music tracks.
- [Get Visual Styles](https://docs.jogg.ai/api-reference/v2/Asset/GetVisualStyles.md): Get available visual styles/templates filtered by aspect ratio. Visual styles determine the look and feel of your product videos.
- [Upload Asset](https://docs.jogg.ai/api-reference/v2/Asset/UploadAsset.md): Upload an asset file and get signed URL for direct upload to cloud storage. Use the returned sign_url to upload your file with a PUT request.
- [Get Custom Avatars](https://docs.jogg.ai/api-reference/v2/Avatar/CustomAvatarsGet.md): Retrieve list of user's instant avatars. Returns user's custom instant avatar collection with filtering options.
- [Check Motion Status](https://docs.jogg.ai/api-reference/v2/Avatar/MotionStatusCheck.md): Check the status of motion generation task by motion ID
- [Generate Photo Avatar](https://docs.jogg.ai/api-reference/v2/Avatar/PhotoAvatarGenerate.md): Generate AI photo avatar based on provided parameters
- [Add Motion to Photo Avatar](https://docs.jogg.ai/api-reference/v2/Avatar/PhotoAvatarMotionAdd.md): Add motion to a photo avatar to make it animated
- [Get Photo Avatar Status](https://docs.jogg.ai/api-reference/v2/Avatar/PhotoAvatarStatusGet.md): Check the status of photo avatar generation task by photo ID
- [Get Photo Avatars](https://docs.jogg.ai/api-reference/v2/Avatar/PhotoAvatarsGet.md): Retrieve list of user's photo avatars. Returns user's photo-based avatar collection with filtering options.
- [Get Public Avatars](https://docs.jogg.ai/api-reference/v2/Avatar/PublicAvatarsGet.md): Retrieve list of public avatars with filtering options. Supports pagination and various filters including aspect ratio, style, gender, age, scene, and ethnicity.
- [Create Product](https://docs.jogg.ai/api-reference/v2/Product/CreateProduct.md): Create a new product with URL analysis or manual input. This is Step 1 in the product video generation workflow.
- [Update Product](https://docs.jogg.ai/api-reference/v2/Product/UpdateProduct.md): Update an existing product information (Step 2 - Optional)
- [Error Handling](https://docs.jogg.ai/api-reference/v2/QuickStart/ErrorHandling.md): API error codes and responses
- [Getting Started](https://docs.jogg.ai/api-reference/v2/QuickStart/GettingStarted.md): Quick start guide for JoggAI API
- [Pricing](https://docs.jogg.ai/api-reference/v2/QuickStart/Pricing.md): API credit consumption and pricing
- [Rate Limits](https://docs.jogg.ai/api-reference/v2/QuickStart/RateLimits.md): API rate limits and usage quotas
- [Get Template by ID](https://docs.jogg.ai/api-reference/v2/Template/GetTemplateById.md): Retrieve detailed information about a specific custom template including its variables.
- [Get Templates](https://docs.jogg.ai/api-reference/v2/Template/GetTemplates.md): Retrieve a list of user's custom templates with optional filtering by aspect ratio.
- [Get Remaining Quota](https://docs.jogg.ai/api-reference/v2/User/GetRemainingQuota.md): Retrieve the remaining JoggAI API quota for the authenticated user
- [Get User Info](https://docs.jogg.ai/api-reference/v2/User/GetUserInfo.md): Easily retrieve and manage your account details with JoggAI API
- [Get Avatar Video Status](https://docs.jogg.ai/api-reference/v2/Video/AvatarVideoGet.md): Get video information and status by video ID
- [Create Lip Sync Video Task](https://docs.jogg.ai/api-reference/v2/Video/CreateLipSyncVideo.md): Submit a video URL and an audio URL to create a lip sync task. Use the returned task ID to poll for processing status and results.
- [Create Video from Avatar](https://docs.jogg.ai/api-reference/v2/Video/CreateVideoFromAvatar.md): Create a video with talking avatar using script or audio input. Either provide a script for text-to-speech or upload an audio file.
- [Create Video from Product](https://docs.jogg.ai/api-reference/v2/Video/CreateVideoFromProduct.md): Create a video from product information with customizable visual style, avatar, voice, and script. This is the final step after creating a product to generate the actual video.
- [Create Video with Template](https://docs.jogg.ai/api-reference/v2/Video/CreateVideoWithTemplate.md): Create a video using a template with custom variables and settings. Templates support various variable types including text, image, video, and script.
- [Get Lip Sync Video Task](https://docs.jogg.ai/api-reference/v2/Video/GetLipSyncVideo.md): Query lip sync task status and result by task ID.
- [Get Product Video Status](https://docs.jogg.ai/api-reference/v2/Video/ProductVideoGet.md): Get the current status and details of a product video generation
- [Render Video from Preview](https://docs.jogg.ai/api-reference/v2/Video/RenderSinglePreview.md): Generate final video from a selected preview
- [Submit Preview List](https://docs.jogg.ai/api-reference/v2/Video/SubmitPreviewList.md): Submit multiple visual styles for preview generation from a product. This allows you to generate multiple preview videos with different styles simultaneously.
- [Get Template Video](https://docs.jogg.ai/api-reference/v2/Video/TemplateVideoGet.md): Retrieve video information, status, and metadata by video ID
- [Translate Video](https://docs.jogg.ai/api-reference/v2/Video/VideoTranslateCreate.md): Create a video translation task with specified parameters including target language, voice, and subtitle options.
- [Check Translation Status](https://docs.jogg.ai/api-reference/v2/Video/VideoTranslateGet.md): Get the current status and details of a video translation task
- [Get Target Languages](https://docs.jogg.ai/api-reference/v2/Video/VideoTranslateTargetLanguagesList.md): Get the list of supported target languages for video translation
- [Get Custom Voices](https://docs.jogg.ai/api-reference/v2/Voice/GetCustomVoices.md): Retrieve a list of user's custom timbres with filtering options. Returns user's personalized voice collection.
- [Get Voices](https://docs.jogg.ai/api-reference/v2/Voice/GetVoices.md): Retrieve a list of available timbres with filtering options. Supports pagination and various filters including gender, language, age, and use case.
- [Add Webhook Endpoint](https://docs.jogg.ai/api-reference/v2/Webhook/AddWebhookEndpoint.md): Create a new webhook endpoint to receive event notifications. You can specify which events to subscribe to and configure the endpoint URL.
- [Delete Webhook Endpoint](https://docs.jogg.ai/api-reference/v2/Webhook/DeleteWebhookEndpoint.md): Remove a webhook endpoint from your account. This action cannot be undone and the endpoint will stop receiving events immediately.
- [List Webhook Endpoints](https://docs.jogg.ai/api-reference/v2/Webhook/ListWebhookEndpoints.md): Retrieve a list of all webhook endpoints configured for your account. Webhooks allow you to receive real-time notifications about events in your JoggAI workspace.
- [List Webhook Events](https://docs.jogg.ai/api-reference/v2/Webhook/ListWebhookEvents.md): Get a list of all available webhook event types that you can subscribe to. Each event type represents a specific action or status change in the system.
- [Update Webhook Endpoint](https://docs.jogg.ai/api-reference/v2/Webhook/UpdateWebhookEndpoint.md): Update an existing webhook endpoint configuration including URL, status, and subscribed events.
- [Welcome to JoggAI](https://docs.jogg.ai/home/WelcometoJoggAI.md): At JoggAI, we enable creators, brands, and enterprises to generate high-quality, engaging AI-driven video content at scale — without the need for cameras, studios, or production teams. From lifelike AI avatar videos, AI video podcasts and AI video ads, every output is powered by cutting-edge generat…

## OpenAPI Specs

- [openapi-v2](https://docs.jogg.ai/api-reference/v2/openapi-v2.yaml)
- [openapi](https://docs.jogg.ai/api-reference/v1/openapi.json)

## Optional

- [Roadmap](https://updates.jogg.ai/roadmap)
- [Changelog](https://updates.jogg.ai/changelog)
- [Share Your Ideas](https://updates.jogg.ai/)