JoggAI icon

JoggAI

Interact with the JoggAI API to create and manage AI videos

Avatar → Create Photo Avatar

AI-generated

Overview

This node operation creates a photo avatar using the JoggAI API. It allows users to generate a motion avatar from a source photo URL, specifying details such as the avatar's name, voice for text-to-speech, and the generation model version. Optional parameters can be added to customize the avatar's behavior, including a description script, photo ID, and a welcome message. This operation is useful for creating personalized AI-driven avatars for applications like virtual assistants, interactive media, or marketing content.

Use Case Examples

  1. Creating a photo avatar from a user's profile picture URL with a specific voice and model version for use in a virtual assistant.
  2. Generating a custom avatar with a welcome message and description script for an interactive marketing campaign.

Properties

Name Meaning
Name A name for the motion avatar, used to identify the created avatar.
Image URL The URL of the source photo used to generate the avatar.
Voice ID The voice ID to use for text-to-speech, defining how the avatar will speak.
Model The generation model version to use for creating the avatar, affecting quality and features.
Optional Fields Additional optional parameters to customize the motion avatar, such as description script, photo ID, and welcome message.

Output

JSON

  • avatarId - The unique identifier of the created photo avatar.
  • name - The name assigned to the created avatar.
  • imageUrl - The source photo URL used for the avatar.
  • voiceId - The voice ID used for text-to-speech in the avatar.
  • modelVersion - The generation model version used to create the avatar.
  • description - The script or description the avatar will speak, if provided.
  • photoId - The ID of a previously generated photo used, if any.
  • welcomeMsg - The custom welcome message set for the avatar, if any.

Dependencies

  • JoggAI API key credential for authentication

Troubleshooting

  • Common issues include invalid or inaccessible image URLs, which can cause avatar creation to fail. Ensure the URL is publicly accessible and points to a valid image file.
  • Voice ID must be valid and supported by the JoggAI service; otherwise, text-to-speech may not work correctly.
  • Description field length must respect the byte limits depending on the model version (under 300 bytes for model 1.0, under 1500 bytes for others). Exceeding these limits can cause errors.
  • API request failures due to network issues or invalid credentials will throw errors; verify API key and network connectivity.

Links

Discussion