Skip to main content
JoggAI logo
  • Category: ai content generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 36
  • Triggers: 0
  • Slug: JOGG_AI
  • Version: 20260826_00

Tools

Slug: JOGG_AI_ANIMATE_PHOTO_AVATARCreate 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

string
required
Name for the reusable animated avatar.
string ("1.0" | "2.0" | "2.0-Pro" | "3.0")
required
Motion model version. Model 2.0-Pro costs more credits than the other documented models.
string
Photo generation ID returned by GENERATE_PHOTO_AVATAR_IMAGE, when available.
string
required
JoggAI voice ID returned by LIST_CREATION_ASSETS.
string
required
Photo-avatar image URL returned by GET_PHOTO_AVATAR_IMAGE.
string
Optional description of the animated avatar.
string
Optional welcome message associated with the avatar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_ANIMATE_PRODUCT_AVATARAdd 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

string
required
Name for the reusable product avatar.
integer ("0" | "1" | "2")
Optional JoggAI motion model selection from 0 through 2.
string
required
JoggAI voice ID returned by LIST_CREATION_ASSETS.
string
required
Natural-language description of the desired presentation motion.
string ("portrait" | "landscape" | "square")
Optional output aspect ratio.
string
required
Selected generation ID returned by GET_PRODUCT_AVATAR_IMAGE_TASK.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_ASSET_UPLOAD_URLCreate 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

string
required
File name including its extension.
integer
File size in bytes, when known.
string
required
MIME type of the file to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_LIP_SYNC_VIDEOStart 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

string
required
Publicly reachable HTTP or HTTPS URL of the source audio.
string
required
Publicly reachable HTTP or HTTPS URL of the source video.
string ("normal" | "normal_reverse" | "normal_reverse_by_audio")
Playback strategy to use when the source video is shorter than the audio.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_PRODUCTCreate 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

string
Product page URL for JoggAI to crawl. Use this alone for the URL variant; omit it when supplying product details manually.
string
Product name. Required for the manual variant and omitted for the URL variant.
array
One or more images or videos for the manually supplied product.
string
Product description and selling points for the manual variant.
string
Target audience for the manually supplied product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_PRODUCT_VIDEOStart 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

object
required
Background audio settings. Pass an empty object for no selected music.
object
required
Voice settings. Pass an empty object to use JoggAI’s default voice.
object
required
Avatar ID and source settings.
object
required
Required script style and language settings.
string
required
Saved product ID returned by CREATE_PRODUCT.
object
required
Video duration, aspect ratio, captions, and naming settings.
string
Optional HTTP(S) callback URL for generation status notifications.
string
Visual style name returned by LIST_CREATION_ASSETS.
string
Exact script to use instead of generated product copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_PRODUCT_VIDEO_PREVIEWSGenerate 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

object
required
Audio configuration. Send an empty object to omit background music.
object
required
Voice configuration. Send an empty object to use JoggAI’s default voice.
object
required
Avatar ID and optional public/custom source type.
object
required
Writing style for JoggAI’s generated product scripts.
string
required
Saved JoggAI product ID returned by CREATE_PRODUCT.
object
required
Duration, aspect ratio, captions, and optional name for the previews.
string
Optional HTTP(S) callback URL for preview status notifications.
array
required
One or more exact visual style names returned by LIST_CREATION_ASSETS with asset_kind=‘visual_style’.
string
Exact script text to use instead of generating a script.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_TALKING_AVATAR_VIDEOStart 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

string
required
Discriminated script or audio input. Supply only fields for the selected type.
object
required
Avatar source and ID for the video.
boolean
Whether to render subtitles in the generated video.
string
Optional name for the generated video.
string
Optional HTTP(S) callback URL for video status notifications.
string ("portrait" | "landscape" | "square")
required
Output video aspect ratio.
integer ("1" | "2" | "3")
required
Layout: 1 full screen, 2 split screen, or 3 picture-in-picture.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_TEMPLATE_VIDEOStart 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

string
Optional text-to-speech voice ID returned by LIST_CREATION_ASSETS.
integer
Optional JoggAI avatar ID.
array
required
Typed template replacements. Text and script variables require content; image and video variables require a public URL or uploaded asset_url.
string
Optional name for the generated template video.
integer ("0" | "1")
Avatar source: 0 for public or 1 for custom. Required with avatar_id.
integer
required
Template ID returned by LIST_CREATION_ASSETS.
string
required
Voice language for text-to-speech.
boolean
Whether to enable captions or subtitles.
integer
Optional background music ID returned by LIST_CREATION_ASSETS.
boolean
Whether to disable all transitions.
boolean
Whether to disable all image effects.
boolean
Whether to disable random transitions.
boolean
Whether to disable random image effects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_CREATE_WEBHOOKCreate 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

string
required
HTTPS callback URL that will receive JoggAI webhook requests.
array
required
One or more event identifiers returned by LIST_WEBHOOK_EVENTS.
string ("enabled" | "disabled")
required
Webhook delivery status: enabled or disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_DELETE_WEBHOOKPermanently delete one JoggAI webhook endpoint. WARNING: this operation is irreversible; confirm the endpoint ID before calling it.

Input Parameters

string
required
Webhook endpoint ID from List Webhooks or Create or Update Webhook. Deletion is permanent and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GENERATE_AI_SCRIPTSStart 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GENERATE_PHOTO_AVATAR_IMAGEStart 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GENERATE_PRODUCT_AVATAR_IMAGESStart 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

string
Optional instructions for the generated product-avatar scene.
string ("low" | "medium" | "high")
required
Image generation quality.
integer
Number of images to generate (1-4). Each additional image may consume additional JoggAI credits.
string
Optional HTTP(S) callback URL for generation status notifications.
string ("3:2" | "2:3" | "1:1")
required
Generated image aspect ratio: ‘3:2’, ‘2:3’, or ‘1:1’.
object
required
Existing-avatar, reference-image, or text-description source for the presenter.
string
required
Publicly reachable product image URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_ACCOUNTReturn the connected JoggAI user and remaining credit balance. Use this before a credit-consuming generation request; JoggAI does not expose a plan name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_AI_SCRIPT_TASKCheck an AI script generation task and return generated scripts when completed.

Input Parameters

string
required
Task ID returned by Generate AI Scripts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_LIP_SYNC_VIDEOCheck a lip-sync task and return its output URLs and duration when successful.

Input Parameters

string
required
Task ID returned by Create Lip Sync Video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_PHOTO_AVATARCheck photo-avatar motion generation and return the reusable avatar details when complete.

Input Parameters

string
required
Motion ID returned by Animate Photo Avatar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_PHOTO_AVATAR_IMAGECheck photo-avatar image generation and return the generated image URLs and keys when ready.

Input Parameters

string
required
Photo generation ID returned by GENERATE_PHOTO_AVATAR_IMAGE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_PRODUCT_AVATARCheck product-avatar motion generation and return the reusable avatar when complete.

Input Parameters

string
required
Motion ID returned by Animate Product Avatar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_PRODUCT_AVATAR_IMAGE_TASKCheck a product-avatar image generation batch and return its status summary and generated image candidates.

Input Parameters

string
required
Batch ID returned by Generate Product Avatar Images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_PRODUCT_VIDEOCheck one product video and return its generated media when available.

Input Parameters

string
required
Product video ID returned by Create Product Video or List Product Videos.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_TALKING_AVATAR_VIDEOCheck a talking-avatar video and return its media URLs when completed.

Input Parameters

string
required
Video ID returned by Create Talking Avatar Video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_TEMPLATE_VIDEOCheck a template-rendered video and return its output details when complete.

Input Parameters

string
required
Video ID returned by Create Template Video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_GET_VIDEO_TRANSLATIONCheck a video translation and return translated media when complete.

Input Parameters

string
required
Translation ID returned by Translate Video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_AVATARSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_CREATION_ASSETSBrowse 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

string ("young" | "middle_aged" | "old")
Voice age-group filter: young, middle_aged, or old.
string
Continuation cursor returned by a prior music or voice call. Repeat the same asset_kind and filters when continuing.
string ("female" | "male")
Voice gender filter: female or male.
string
Voice language filter, such as english.
string
Voice use-case filter, such as narrative_story.
integer
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.
string ("music" | "template" | "visual_style" | "voice")
required
Creation asset catalog to query: music, template, visual_style, or voice.
string
Aspect-ratio filter for templates or visual styles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_PRODUCT_PREVIEWSList generated JoggAI product-video previews and their statuses one page at a time. Preserve the returned preview identifier for selective rendering.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_PRODUCT_VIDEOSList product videos with status and sort filters, one bounded page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_TRANSLATION_LANGUAGESReturn currently supported lowercase target-language identifiers for JoggAI video translation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_WEBHOOK_EVENTSReturn event identifiers that can be subscribed to by a JoggAI webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_LIST_WEBHOOKSList webhook endpoints registered on the connected JoggAI account. Signing secrets are never returned by this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_RENDER_PRODUCT_VIDEO_PREVIEWRender one selected product preview into a final video. WARNING: this consumes JoggAI render credits and creates persistent media.

Input Parameters

string
required
Preview ID returned by List Product Previews.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_TRANSLATE_VIDEOStart 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

string
Optional title for the translated video.
string
required
Publicly reachable source video URL.
string
Optional HTTP(S) callback URL for translation status notifications.
string
Optional voice ID for the dubbed audio.
boolean
Whether to add translated subtitles.
string
required
Target language identifier returned by LIST_TRANSLATION_LANGUAGES.
boolean
Whether to translate audio without lip sync.
boolean
Whether to adjust video duration to the translated speech.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_UPDATE_PRODUCTUpdate 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

string
Replacement product name.
array
Complete replacement media list. Pass an empty list to remove all media.
string
required
Product ID returned by Create Product.
string
Replacement product description.
string
Replacement target audience.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOGG_AI_UPDATE_WEBHOOKFully replace an existing JoggAI webhook’s callback URL, delivery status, and event subscriptions.

Input Parameters

string
required
Replacement HTTPS callback URL for the webhook.
array
required
Complete replacement event list using identifiers from LIST_WEBHOOK_EVENTS.
string ("enabled" | "disabled")
required
Replacement webhook delivery status: enabled or disabled.
string
required
Existing webhook endpoint ID returned by LIST_WEBHOOKS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not