JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Video → Create from Avatar

AI-generated

Overview

This node operation creates a video using an avatar as the source. It allows users to specify the avatar type and ID, select a text-to-speech voice, choose the background style for the video, and provide either a text script or an audio file URL for the avatar to lip-sync. Additional options include setting the aspect ratio, enabling captions, and naming the output video. This operation is useful for generating AI-driven avatar videos for presentations, marketing, or content creation.

Use Case Examples

  1. Creating a promotional video with a custom avatar speaking a scripted message.
  2. Generating a video with a predefined avatar lip-syncing to an uploaded audio file.

Properties

Name Meaning
Avatar Type Source type of the avatar, either a predefined Jogg Avatar or a user-provided avatar.
Avatar ID ID of the avatar to use for the video.
Voice ID ID of the text-to-speech (TTS) voice to use for the avatar's speech.
Screen Style Background style for the output video, such as with background, green screen, or transparent background (WebM).
Audio Source Choose to provide a text script for the AI to speak or a direct URL to an audio file for lip-syncing.
Script Script content for the avatar to speak when using text script as the audio source.
Audio URL URL for the audio file that the avatar will lip-sync to when using audio file URL as the audio source.
Additional Options Additional settings for the video such as aspect ratio, caption enabling, and video name.

Output

JSON

  • videoId - Identifier of the created video.
  • videoUrl - URL to access the created video.
  • status - Status of the video creation process.

Dependencies

  • Requires an API key credential for authentication with the JoggAI API.

Troubleshooting

  • Common issues include invalid avatar ID or voice ID, which may cause the API request to fail. Verify that the IDs are correct and exist in the system.
  • Errors related to audio source mismatch, such as providing a script when an audio URL is expected, or vice versa. Ensure the correct audio source option is selected and the corresponding input is provided.
  • Network or API errors may occur; check API key validity and network connectivity.
  • If the video creation fails, check the error message returned by the API for specific details and adjust parameters accordingly.

Links

Discussion