---
canonical_url: "https://docs.composio.dev/toolkits/jogg_ai"
markdown_url: "https://docs.composio.dev/toolkits/jogg_ai.md"
product: "platform"
version: null
last_updated: null
---

# JoggAI

JoggAI provides APIs for creating AI avatar, product, lip-sync, template, and translated videos and managing their supporting media assets.

- **Category:** ai content generation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 36
- **Triggers:** 0
- **Slug:** `JOGG_AI`
- **Version:** 20260826_00

## Tools

### Animate Photo Avatar

**Slug:** `JOGG_AI_ANIMATE_PHOTO_AVATAR`

Create a reusable animated avatar from a photo-avatar image. WARNING: this generation creates persistent media and costs at least 2 JoggAI credits; the 2.0-Pro model costs 3 credits. Call GET_ACCOUNT first to check the remaining balance. Returns a motion ID for GET_PHOTO_AVATAR.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the reusable animated avatar. |
| `model` | string ("1.0" | "2.0" | "2.0-Pro" | "3.0") | Yes | Motion model version. Model 2.0-Pro costs more credits than the other documented models. |
| `photo_id` | string | No | Photo generation ID returned by GENERATE_PHOTO_AVATAR_IMAGE, when available. |
| `voice_id` | string | Yes | JoggAI voice ID returned by LIST_CREATION_ASSETS. |
| `image_url` | string | Yes | Photo-avatar image URL returned by GET_PHOTO_AVATAR_IMAGE. |
| `description` | string | No | Optional description of the animated avatar. |
| `welcome_msg` | string | No | Optional welcome message associated with the avatar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Animate Product Avatar

**Slug:** `JOGG_AI_ANIMATE_PRODUCT_AVATAR`

Add motion and a voice to a selected JoggAI product-avatar image generation. WARNING: this call consumes JoggAI credits and creates persistent media; call GET_ACCOUNT first to check the remaining balance. Returns a motion ID for GET_PRODUCT_AVATAR.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the reusable product avatar. |
| `model` | integer ("0" | "1" | "2") | No | Optional JoggAI motion model selection from 0 through 2. |
| `voice_id` | string | Yes | JoggAI voice ID returned by LIST_CREATION_ASSETS. |
| `description` | string | Yes | Natural-language description of the desired presentation motion. |
| `aspect_ratio` | string ("portrait" | "landscape" | "square") | No | Optional output aspect ratio. |
| `generation_id` | string | Yes | Selected generation ID returned by GET_PRODUCT_AVATAR_IMAGE_TASK. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Asset Upload URL

**Slug:** `JOGG_AI_CREATE_ASSET_UPLOAD_URL`

Create a signed URL for uploading an asset to JoggAI. This does not upload the file bytes; PUT them to sign_url separately, then use asset_url in a generation request, including as a template image or video variable's url.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | File name including its extension. |
| `file_size` | integer | No | File size in bytes, when known. |
| `content_type` | string | Yes | MIME type of the file to upload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lip Sync Video

**Slug:** `JOGG_AI_CREATE_LIP_SYNC_VIDEO`

Start an asynchronous lip-sync video from publicly reachable video and audio URLs. WARNING: this request consumes JoggAI credits; call GET_ACCOUNT first to check the remaining balance. Returns a task ID for GET_LIP_SYNC_VIDEO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `audio_url` | string | Yes | Publicly reachable HTTP or HTTPS URL of the source audio. |
| `video_url` | string | Yes | Publicly reachable HTTP or HTTPS URL of the source video. |
| `playback_type` | string ("normal" | "normal_reverse" | "normal_reverse_by_audio") | No | Playback strategy to use when the source video is shorter than the audio. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `JOGG_AI_CREATE_PRODUCT`

Create product information from exactly one source: a product page URL, or manually supplied product details. WARNING: this creates a persistent JoggAI product, and API v2 provides no read or delete product endpoint. Retain this tool's returned product ID and details because the side effect cannot be read back or automatically reversed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Product page URL for JoggAI to crawl. Use this alone for the URL variant; omit it when supplying product details manually. |
| `name` | string | No | Product name. Required for the manual variant and omitted for the URL variant. |
| `media` | array | No | One or more images or videos for the manually supplied product. |
| `description` | string | No | Product description and selling points for the manual variant. |
| `target_audience` | string | No | Target audience for the manually supplied product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Video

**Slug:** `JOGG_AI_CREATE_PRODUCT_VIDEO`

Start a product video using a saved product and nested video, avatar, voice, audio, and script settings. WARNING: this call consumes JoggAI credits and creates persistent media; call GET_ACCOUNT first to check the remaining balance. Returns an ID for GET_PRODUCT_VIDEO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `audio` | object | Yes | Background audio settings. Pass an empty object for no selected music. |
| `voice` | object | Yes | Voice settings. Pass an empty object to use JoggAI's default voice. |
| `avatar` | object | Yes | Avatar ID and source settings. |
| `script` | object | Yes | Required script style and language settings. |
| `product_id` | string | Yes | Saved product ID returned by CREATE_PRODUCT. |
| `video_spec` | object | Yes | Video duration, aspect ratio, captions, and naming settings. |
| `webhook_url` | string | No | Optional HTTP(S) callback URL for generation status notifications. |
| `visual_style` | string | No | Visual style name returned by LIST_CREATION_ASSETS. |
| `override_script` | string | No | Exact script to use instead of generated product copy. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Video Previews

**Slug:** `JOGG_AI_CREATE_PRODUCT_VIDEO_PREVIEWS`

Generate product-video previews for one or more visual styles. WARNING: this call consumes JoggAI preview credits and creates persistent previews; API v2 provides no preview delete endpoint. Call GET_ACCOUNT first to check credits, then use LIST_PRODUCT_PREVIEWS to retrieve status and preview IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `audio` | object | Yes | Audio configuration. Send an empty object to omit background music. |
| `voice` | object | Yes | Voice configuration. Send an empty object to use JoggAI's default voice. |
| `avatar` | object | Yes | Avatar ID and optional public/custom source type. |
| `script` | object | Yes | Writing style for JoggAI's generated product scripts. |
| `product_id` | string | Yes | Saved JoggAI product ID returned by CREATE_PRODUCT. |
| `video_spec` | object | Yes | Duration, aspect ratio, captions, and optional name for the previews. |
| `webhook_url` | string | No | Optional HTTP(S) callback URL for preview status notifications. |
| `visual_styles` | array | Yes | One or more exact visual style names returned by LIST_CREATION_ASSETS with asset_kind='visual_style'. |
| `override_script` | string | No | Exact script text to use instead of generating a script. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Talking Avatar Video

**Slug:** `JOGG_AI_CREATE_TALKING_AVATAR_VIDEO`

Start a talking-avatar video using an avatar and either a text script or hosted audio. WARNING: this call consumes JoggAI credits and creates persistent media; call GET_ACCOUNT first to check the remaining balance. Returns a video ID for GET_TALKING_AVATAR_VIDEO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `voice` | string | Yes | Discriminated script or audio input. Supply only fields for the selected type. |
| `avatar` | object | Yes | Avatar source and ID for the video. |
| `caption` | boolean | No | Whether to render subtitles in the generated video. |
| `video_name` | string | No | Optional name for the generated video. |
| `webhook_url` | string | No | Optional HTTP(S) callback URL for video status notifications. |
| `aspect_ratio` | string ("portrait" | "landscape" | "square") | Yes | Output video aspect ratio. |
| `screen_style` | integer ("1" | "2" | "3") | Yes | Layout: 1 full screen, 2 split screen, or 3 picture-in-picture. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template Video

**Slug:** `JOGG_AI_CREATE_TEMPLATE_VIDEO`

Start rendering a JoggAI v2 template with typed text, script, image, or video variables and optional avatar, voice, captions, and music settings. WARNING: this call consumes JoggAI credits and creates persistent media; call GET_ACCOUNT first to check the remaining balance. Returns a video ID for GET_TEMPLATE_VIDEO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `voice_id` | string | No | Optional text-to-speech voice ID returned by LIST_CREATION_ASSETS. |
| `avatar_id` | integer | No | Optional JoggAI avatar ID. |
| `variables` | array | Yes | Typed template replacements. Text and script variables require content; image and video variables require a public URL or uploaded asset_url. |
| `video_name` | string | No | Optional name for the generated template video. |
| `avatar_type` | integer ("0" | "1") | No | Avatar source: 0 for public or 1 for custom. Required with avatar_id. |
| `template_id` | integer | Yes | Template ID returned by LIST_CREATION_ASSETS. |
| `voice_language` | string | Yes | Voice language for text-to-speech. |
| `captions_enabled` | boolean | No | Whether to enable captions or subtitles. |
| `background_music_id` | integer | No | Optional background music ID returned by LIST_CREATION_ASSETS. |
| `disable_all_transitions` | boolean | No | Whether to disable all transitions. |
| `disable_all_image_effects` | boolean | No | Whether to disable all image effects. |
| `disable_random_transitions` | boolean | No | Whether to disable random transitions. |
| `disable_random_image_effects` | boolean | No | Whether to disable random image effects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `JOGG_AI_CREATE_WEBHOOK`

Create a JoggAI webhook endpoint with a callback URL, delivery status, and event subscriptions. Returns a one-time sensitive signing secret; store it securely and never log it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTPS callback URL that will receive JoggAI webhook requests. |
| `events` | array | Yes | One or more event identifiers returned by LIST_WEBHOOK_EVENTS. |
| `status` | string ("enabled" | "disabled") | Yes | Webhook delivery status: enabled or disabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `JOGG_AI_DELETE_WEBHOOK`

Permanently delete one JoggAI webhook endpoint. WARNING: this operation is irreversible; confirm the endpoint ID before calling it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint_id` | string | Yes | Webhook endpoint ID from List Webhooks or Create or Update Webhook. Deletion is permanent and cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate AI Scripts

**Slug:** `JOGG_AI_GENERATE_AI_SCRIPTS`

Start asynchronous AI script generation from a saved product or inline product details. WARNING: this request may consume JoggAI credits; call GET_ACCOUNT first to check the remaining balance. Returns a task ID, not completed scripts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string ("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") | Yes | Lowercase language identifier supported by JoggAI API v2. |
| `product_info` | object | Yes | A saved product ID or complete inline product details. |
| `script_style` | string ("Don't Worry" | "Storytime" | "Discovery" | "Data" | "Top 3 reasons" | "Light marketing") | Yes | Exact JoggAI writing style to apply to the generated script. |
| `target_audience` | string | No | Optional intended audience for the generated script. |
| `video_length_seconds` | string ("15" | "30" | "60") | Yes | Target script duration in seconds: '15', '30', or '60'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Photo Avatar Image

**Slug:** `JOGG_AI_GENERATE_PHOTO_AVATAR_IMAGE`

Start AI photo-avatar image generation using JoggAI's exact demographic, style, model, and aspect-ratio modes. WARNING: this call consumes credits and creates persistent media; documented pricing is 0.05 credit per single image or 0.2 credit for a batch of four. Call GET_ACCOUNT first to check the remaining balance. Returns a photo ID for GET_PHOTO_AVATAR_IMAGE.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `age` | string ("Teenager" | "Young adult" | "Adult" | "Elderly") | Yes | Exact JoggAI avatar age group. |
| `model` | string ("classic" | "modern") | Yes | JoggAI photo generation model: 'classic' or 'modern'. |
| `gender` | string ("Female" | "Male") | Yes | Exact JoggAI avatar gender. |
| `ethnicity` | string ("European" | "African" | "South Asian" | "East Asian" | "Middle Eastern" | "South American" | "North American") | No | Optional exact JoggAI ethnicity category for the generated avatar. |
| `image_url` | string | No | Optional publicly reachable reference image URL. |
| `appearance` | string | No | Optional natural-language description of the avatar's appearance. |
| `background` | string | No | Optional natural-language description of the desired background. |
| `aspect_ratio` | string ("portrait" | "landscape" | "square") | Yes | Generated photo aspect ratio. |
| `avatar_style` | string ("Professional" | "Social") | Yes | Exact JoggAI avatar style category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Product Avatar Images

**Slug:** `JOGG_AI_GENERATE_PRODUCT_AVATAR_IMAGES`

Start asynchronous generation of one to four product-avatar images from a public product image and an existing avatar, reference image, or description. WARNING: this call consumes JoggAI credits for persistent media, and requesting more images may consume more credits. Call GET_ACCOUNT first to check the remaining balance. Returns a batch ID for GET_PRODUCT_AVATAR_IMAGE_TASK.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | No | Optional instructions for the generated product-avatar scene. |
| `quality` | string ("low" | "medium" | "high") | Yes | Image generation quality. |
| `num_images` | integer | No | Number of images to generate (1-4). Each additional image may consume additional JoggAI credits. |
| `webhook_url` | string | No | Optional HTTP(S) callback URL for generation status notifications. |
| `aspect_ratio` | string ("3:2" | "2:3" | "1:1") | Yes | Generated image aspect ratio: '3:2', '2:3', or '1:1'. |
| `avatar_source` | object | Yes | Existing-avatar, reference-image, or text-description source for the presenter. |
| `product_image_url` | string | Yes | Publicly reachable product image URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account and Credit Balance

**Slug:** `JOGG_AI_GET_ACCOUNT`

Return the connected JoggAI user and remaining credit balance. Use this before a credit-consuming generation request; JoggAI does not expose a plan name.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AI Script Task

**Slug:** `JOGG_AI_GET_AI_SCRIPT_TASK`

Check an AI script generation task and return generated scripts when completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by Generate AI Scripts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lip Sync Video

**Slug:** `JOGG_AI_GET_LIP_SYNC_VIDEO`

Check a lip-sync task and return its output URLs and duration when successful.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by Create Lip Sync Video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Photo Avatar

**Slug:** `JOGG_AI_GET_PHOTO_AVATAR`

Check photo-avatar motion generation and return the reusable avatar details when complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `motion_id` | string | Yes | Motion ID returned by Animate Photo Avatar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Photo Avatar Image

**Slug:** `JOGG_AI_GET_PHOTO_AVATAR_IMAGE`

Check photo-avatar image generation and return the generated image URLs and keys when ready.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | string | Yes | Photo generation ID returned by GENERATE_PHOTO_AVATAR_IMAGE. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Avatar

**Slug:** `JOGG_AI_GET_PRODUCT_AVATAR`

Check product-avatar motion generation and return the reusable avatar when complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `motion_id` | string | Yes | Motion ID returned by Animate Product Avatar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Avatar Image Task

**Slug:** `JOGG_AI_GET_PRODUCT_AVATAR_IMAGE_TASK`

Check a product-avatar image generation batch and return its status summary and generated image candidates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Batch ID returned by Generate Product Avatar Images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Video

**Slug:** `JOGG_AI_GET_PRODUCT_VIDEO`

Check one product video and return its generated media when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_video_id` | string | Yes | Product video ID returned by Create Product Video or List Product Videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Talking Avatar Video

**Slug:** `JOGG_AI_GET_TALKING_AVATAR_VIDEO`

Check a talking-avatar video and return its media URLs when completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID returned by Create Talking Avatar Video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Video

**Slug:** `JOGG_AI_GET_TEMPLATE_VIDEO`

Check a template-rendered video and return its output details when complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID returned by Create Template Video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Translation

**Slug:** `JOGG_AI_GET_VIDEO_TRANSLATION`

Check a video translation and return translated media when complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_translate_id` | string | Yes | Translation ID returned by Translate Video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Avatars

**Slug:** `JOGG_AI_LIST_AVATARS`

List public, instant, photo, or product avatars available for JoggAI video generation. Filters vary by avatar kind; returned IDs can be used in generation tools. This toolkit can create photo and product avatars; JoggAI API v2 only permits listing pre-existing instant avatars.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `age` | string ("adult" | "senior" | "young_adult") | No | Age-group filter for public avatars. |
| `name` | string | No | Name filter for instant or photo avatars. |
| `scene` | string ("lifestyle" | "outdoors" | "business" | "studio" | "health_fitness" | "education" | "news") | No | Scene filter for public avatars. |
| `style` | string ("professional" | "social") | No | Style filter for public avatars. |
| `cursor` | string | No | Opaque continuation cursor from a prior instant or photo response. Omit for the first page. |
| `gender` | string ("female" | "male") | No | Gender filter for public avatars. |
| `status` | string ("processing" | "completed" | "failed") | No | Status filter for instant or photo avatars. |
| `ethnicity` | string ("european" | "african" | "south_asian" | "east_asian" | "middle_eastern" | "south_american" | "north_american") | No | Ethnicity filter for public avatars. |
| `page_size` | integer | No | Avatars requested per instant or photo page (1-100). Public and product catalogs ignore this value. |
| `avatar_kind` | string ("public" | "instant" | "photo" | "product") | Yes | Avatar catalog to query: public, instant, photo, or product. Instant avatars must already exist because JoggAI API v2 exposes no instant-avatar creation endpoint. |
| `aspect_ratio` | string ("portrait" | "landscape" | "square") | No | Aspect-ratio filter for public or product avatars. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Creation Assets

**Slug:** `JOGG_AI_LIST_CREATION_ASSETS`

Browse one music, template, visual-style, or voice catalog used to create JoggAI media. Returns one page for music/voice and complete template/style catalogs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `age` | string ("young" | "middle_aged" | "old") | No | Voice age-group filter: young, middle_aged, or old. |
| `cursor` | string | No | Continuation cursor returned by a prior music or voice call. Repeat the same asset_kind and filters when continuing. |
| `gender` | string ("female" | "male") | No | Voice gender filter: female or male. |
| `language` | string | No | Voice language filter, such as english. |
| `use_case` | string | No | Voice use-case filter, such as narrative_story. |
| `page_size` | integer | No | Requested items per page for music or voice (1-100). Voice page 1 may ignore this value. Templates and visual styles are returned in full. |
| `asset_kind` | string ("music" | "template" | "visual_style" | "voice") | Yes | Creation asset catalog to query: music, template, visual_style, or voice. |
| `aspect_ratio` | string | No | Aspect-ratio filter for templates or visual styles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Previews

**Slug:** `JOGG_AI_LIST_PRODUCT_PREVIEWS`

List generated JoggAI product-video previews and their statuses one page at a time. Preserve the returned preview identifier for selective rendering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor returned by a prior call; omit for the first page. |
| `status` | integer ("3" | "4" | "5") | No | Filter by provider status: 3 processing, 4 successful, or 5 failed. |
| `sort_by` | string | No | Provider-supported field to sort by, such as created_at. |
| `page_size` | integer | No | Product previews to return per page (1-100). |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: asc or desc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Videos

**Slug:** `JOGG_AI_LIST_PRODUCT_VIDEOS`

List product videos with status and sort filters, one bounded page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by a prior LIST_PRODUCT_VIDEOS call. |
| `status` | integer ("3" | "4" | "5") | No | Provider status filter: 3 processing, 4 successful, or 5 failed. |
| `sort_by` | string | No | Provider-supported field by which to sort product videos. |
| `page_size` | integer | No | Maximum number of product videos to return on this page (1-100). |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for sort_by. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Translation Languages

**Slug:** `JOGG_AI_LIST_TRANSLATION_LANGUAGES`

Return currently supported lowercase target-language identifiers for JoggAI video translation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Events

**Slug:** `JOGG_AI_LIST_WEBHOOK_EVENTS`

Return event identifiers that can be subscribed to by a JoggAI webhook.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `JOGG_AI_LIST_WEBHOOKS`

List webhook endpoints registered on the connected JoggAI account. Signing secrets are never returned by this tool.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Render Product Video Preview

**Slug:** `JOGG_AI_RENDER_PRODUCT_VIDEO_PREVIEW`

Render one selected product preview into a final video. WARNING: this consumes JoggAI render credits and creates persistent media.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `preview_id` | string | Yes | Preview ID returned by List Product Previews. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Translate Video

**Slug:** `JOGG_AI_TRANSLATE_VIDEO`

Start asynchronous video translation with optional audio-only translation, dubbing, lip sync, subtitles, and dynamic duration. WARNING: this call consumes JoggAI credits and creates persistent translated media; call GET_ACCOUNT first to check the remaining balance. Returns a translation task ID for GET_VIDEO_TRANSLATION.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Optional title for the translated video. |
| `video_url` | string | Yes | Publicly reachable source video URL. |
| `callback_url` | string | No | Optional HTTP(S) callback URL for translation status notifications. |
| `output_voice` | string | No | Optional voice ID for the dubbed audio. |
| `add_subtitles` | boolean | No | Whether to add translated subtitles. |
| `output_language` | string | Yes | Target language identifier returned by LIST_TRANSLATION_LANGUAGES. |
| `translate_audio_only` | boolean | No | Whether to translate audio without lip sync. |
| `enable_dynamic_duration` | boolean | No | Whether to adjust video duration to the translated speech. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `JOGG_AI_UPDATE_PRODUCT`

Update an existing JoggAI product's descriptive fields. Supplying media replaces the complete media list; pass an empty list to remove all media. JoggAI API v2 has no product read endpoint, so retain the product details in your own workflow state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement product name. |
| `media` | array | No | Complete replacement media list. Pass an empty list to remove all media. |
| `product_id` | string | Yes | Product ID returned by Create Product. |
| `description` | string | No | Replacement product description. |
| `target_audience` | string | No | Replacement target audience. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `JOGG_AI_UPDATE_WEBHOOK`

Fully replace an existing JoggAI webhook's callback URL, delivery status, and event subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Replacement HTTPS callback URL for the webhook. |
| `events` | array | Yes | Complete replacement event list using identifiers from LIST_WEBHOOK_EVENTS. |
| `status` | string ("enabled" | "disabled") | Yes | Replacement webhook delivery status: enabled or disabled. |
| `endpoint_id` | string | Yes | Existing webhook endpoint ID returned by LIST_WEBHOOKS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |