JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Overview

This node allows users to create AI-generated videos based on predefined templates using the JoggAI API. Specifically, the "Create from Template" operation under the "Video" resource enables generating a video by selecting a template (either public or user-owned), specifying language for text-to-speech conversion, and providing variables to customize the content dynamically.

Common scenarios include:

  • Automating video creation for marketing campaigns by filling in personalized data into video templates.
  • Generating multilingual videos with voiceovers in different languages.
  • Quickly producing videos with dynamic text, images, or scripts without manual editing.

Practical example:
A marketing team wants to produce promotional videos for different products. They select a public template, specify product names and images as variables, choose English as the language, and generate customized videos automatically.

Properties

Name Meaning
Template Type The source of the template to use. Options: "Public Template" (common) or "My Template" (user).
Template ID The numeric ID of the template to use for video creation.
Language Language for text-to-speech (TTS) conversion in the video. Supported languages include English, Filipino, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Malay, Portuguese, Russian, Spanish, Thai, Vietnamese, Arabic, Greek, Turkish, Slovenian, Croatian, Romanian, Simplified 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.
Template Variables A list of variables to replace placeholders in the template. Each variable has:
- Type: one of Text Content, Image Content, Video Content, Script Content.
- Name: the variable's name.
- Properties:
  • For text/script: content string.
  • For image/video: URL string.
Optional Overrides Optional settings to override predefined template settings:
- Avatar ID: numeric ID to override avatar.
- Avatar Type: source of avatar, either Public Avatar or Custom Avatar.
- Enable Captions: boolean to enable/disable captions.
- Music ID: numeric ID to override background music.
- Voice ID: string to override voice used in TTS (e.g., "en-US-ChristopherNeural").

Output

The node outputs JSON data representing the result of the video creation request. This typically includes metadata about the created video such as its ID, status, URLs, or other relevant information returned by the JoggAI API.

If the node supports binary output (not explicitly shown here), it would represent media files like generated video content or thumbnails. However, based on the provided code and properties, the primary output is structured JSON data describing the created video.

Dependencies

  • Requires an API key credential for authenticating requests to the JoggAI API.
  • The node depends on the external JoggAI service to process templates and generate videos.
  • Proper network connectivity to the JoggAI API endpoint is necessary.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Template ID: Ensure the template ID exists and is accessible under the selected template type.
    • Unsupported language code: Verify that the chosen language is supported for TTS.
    • Incorrect variable names or missing required variables: All placeholders in the template must be supplied with corresponding variables.
    • Network or authentication errors: Confirm that the API key is valid and the service is reachable.
  • Error messages:

    • "request failed: <message>" — Indicates an error during API communication. Check credentials, network, and input parameters.
    • Validation errors related to missing or invalid inputs will be thrown if required properties are not set correctly.
  • To resolve errors, verify all input parameters, ensure correct API credentials, and consult the JoggAI API documentation for template and variable requirements.

Links and References

Discussion