JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Overview

The node integrates with the JoggAI API to create and manage AI-generated avatars based on photos. Specifically, the Create Photo Avatar operation allows users to generate a motion avatar from a source photo URL, assign it a name, select a voice for text-to-speech, and choose a generation model version. This is useful in scenarios such as creating personalized virtual assistants, digital spokespersons, or interactive characters for marketing, education, or entertainment.

For example, a user can input a photo URL of a person, specify a voice ID for narration, and generate an animated avatar that speaks a custom script or greeting message.

Properties

Name Meaning
Name A name assigned to the motion avatar for identification.
Image URL The URL pointing to the source photo used to generate the avatar.
Voice ID The identifier of the voice used for text-to-speech synthesis by the avatar.
Model The generation model version to use. Options: "1.0", "2.0", "2.0-Pro", "3.0".
Optional Fields Additional parameters to customize the avatar:
- Description Script or description text that the avatar will speak.
- Description Limit Notice Note about character limits for the description field depending on the model version.
- Photo ID ID of a previously generated photo to reuse instead of providing a new image URL.
- Welcome Message Custom greeting message to replace the default one spoken by the avatar.

Output

The node outputs JSON data representing the result of the avatar creation request. This typically includes details about the generated avatar such as its ID, status, and any metadata returned by the JoggAI API.

If the node supports binary data output (not explicitly shown here), it would represent media files related to the avatar, such as video or audio streams.

Dependencies

  • Requires an active connection to the JoggAI API.
  • Needs an API key credential configured in n8n for authentication.
  • Internet access to fetch the source photo from the provided URL.
  • Proper configuration of voice IDs supported by the JoggAI service.

Troubleshooting

  • Common Issues:

    • Invalid or inaccessible Image URL leading to failure in fetching the source photo.
    • Unsupported or incorrect Voice ID causing text-to-speech errors.
    • Exceeding character limits in the Description field results in validation errors.
    • Using an invalid or expired API key will cause authentication failures.
  • Error Messages:

    • "request failed: <message>" indicates an error during the API call; check network connectivity, credentials, and parameter validity.
    • Validation errors related to description length should be resolved by shortening the text according to the model's byte limits.
    • Authentication errors require verifying the API key credential setup.

Links and References

  • JoggAI Official Documentation (placeholder link, replace with actual)
  • Text-to-Speech voice options documentation (refer to JoggAI voice catalog)
  • API usage guidelines and rate limits (refer to JoggAI developer portal)

Discussion