JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Overview

The "Video - Create from Product" operation in this node enables users to generate AI-powered videos based on an existing product. By providing a product ID and configuring various parameters such as aspect ratio, video length, language, script style, avatar presentation, visual styling, voice, music, and optional script overrides, users can automatically create customized promotional or informational videos.

This operation is beneficial for marketers, e-commerce businesses, and content creators who want to quickly produce engaging product videos without manual video editing. For example, after creating a product entry in a prior step, a user can generate a short 15-second portrait video with a soft selling script style, featuring a chosen avatar and background music, ready for social media sharing.

Properties

Name Meaning
Product ID The unique identifier of the product to base the video on. This ID should come from a previously created product step.
Aspect Ratio The final video's aspect ratio. Options: Portrait [9:16], Landscape [16:9], Square [1:1].
Video Length Target duration of the video in seconds. Options: 15, 30, 60.
Language Language used for generating the video script. Multiple languages supported including English, French, Spanish, Chinese, Arabic, and many more.
Script Style Writing style for the video script. Options include casual, exploratory, fact-based, list-based persuasive, humor, storytelling, expert advice, unboxing review, challenge, problem/solution, comparison, creative, emotional appeal, immersive storytelling, etc.
Avatar Type Source type of the avatar presenting the video. Options: Public Avatars, Custom Avatars.
Avatar ID Numeric ID selecting the specific avatar to use.
Template Type Source of the video template. Options: Template From Template Library (public), Template From My Templates (custom).
Template ID Numeric ID of the selected video template from the chosen library.
Visual Style Optional string specifying a visual style from the available visual styles list.
Voice ID Identifier of the voice to be used for narration or speech synthesis in the video. Default example: "en-US-ChristopherNeural".
Music ID Numeric ID of the background music track to include in the video.
Override Script Optional multiline text input to override the automatically generated script with a custom script.
Video Name Optional custom name for the generated video file.
Show Captions Boolean flag indicating whether subtitles/captions should be rendered on the video.

Output

The output JSON contains details about the created video(s). Typically, it includes metadata such as video IDs, URLs, status, and other relevant information returned by the JoggAI API after video creation.

If the node supports binary data output (not explicitly shown here), it would represent the actual video file or related media assets.

Dependencies

  • Requires an active connection to the JoggAI API service.
  • An API key credential must be configured in n8n to authenticate requests.
  • The node depends on several internal modules handling different resources like Video, Avatar, Voice, Template, Product, AI Script, File, Music, Visual Style, and Webhook operations.
  • Proper configuration of these resources and their IDs (e.g., productId, avatarId, templateId) is necessary for successful video creation.

Troubleshooting

  • Common Issues:

    • Invalid or missing Product ID: Ensure the product ID is correctly obtained from a previous product creation step.
    • Incorrect Avatar or Template IDs: Verify that the avatar and template IDs exist and are accessible.
    • Unsupported language or voice ID: Confirm that the selected language and voice ID are supported by the API.
    • Network or authentication errors: Check API key validity and network connectivity.
  • Error Messages:

    • "request failed: <message>": Indicates an API call failure; check error message details for specifics.
    • Validation errors for required fields: Make sure all mandatory properties are provided.
    • Permission denied or unauthorized: Verify API credentials and permissions.
  • Resolutions:

    • Double-check all input parameters for correctness.
    • Ensure API credentials are valid and have sufficient permissions.
    • Review API documentation for limits or constraints on inputs.
    • Use the "continue on fail" option to handle errors gracefully during batch processing.

Links and References

  • JoggAI Documentation (placeholder link from bundled code constant)
  • Refer to the official JoggAI API docs for detailed parameter descriptions and examples.
  • n8n documentation on Creating Custom Nodes for further customization guidance.

Discussion