Tavus icon

Tavus

Work with Tavus API for AI-driven video generation

Actions20

Overview

This node integrates with the Tavus API to create AI-driven videos using a specified replica and script. It is designed to generate personalized video content by leveraging a digital replica (an AI avatar) that speaks the provided script. This is useful in scenarios such as marketing campaigns, personalized customer engagement, training videos, or any application requiring dynamic video generation with synthetic avatars.

For example, you can use this node to:

  • Generate a personalized welcome video for new users by specifying a replica ID and a custom script.
  • Create training videos where the avatar explains concepts dynamically based on input scripts.
  • Produce marketing videos with different replicas representing various personas.

Properties

Name Meaning
Replica ID The unique identifier of the replica (AI avatar) to be used for generating the video.
Script The text script that the replica will speak in the generated video.
Additional Fields Optional extra settings for the video creation:
- Video Name A custom name to assign to the generated video.
- Background URL A URL linking to a website to be used as the video's background.
- Background Source URL A direct link to a video file to serve as the background.
- Callback URL A URL to receive a callback notification when video generation completes.
- Fast Generation Boolean flag to enable fast rendering mode, which disables some features for speed.
- Transparent Background Boolean flag to generate the video with a transparent background; requires fast generation enabled.
- Watermark Image URL A direct link to an image (PNG or JPEG) to be used as a watermark on the video.

Output

The node outputs JSON data representing the response from the Tavus API after creating the video. This typically includes metadata about the created video such as its ID, status, URLs to access the video, and other relevant details returned by the API.

If the video generation process supports asynchronous callbacks (via the callback URL), the initial output may contain information about the job submission rather than the final video.

No binary data is directly output by this node; all results are delivered as structured JSON.

Dependencies

  • Requires an active connection to the Tavus API service.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • Network access to Tavus endpoints and any URLs provided for backgrounds or watermarks must be accessible.

Troubleshooting

  • Invalid Replica ID: If the provided replica ID does not exist or is incorrect, the API will return an error. Verify the replica ID before running the node.
  • Malformed JSON in Additional Fields: Although most additional fields are simple types, if JSON strings are used elsewhere (not in this operation), ensure they are valid to avoid parsing errors.
  • Callback URL Issues: If using a callback URL, ensure it is publicly accessible and correctly handles incoming webhook requests.
  • Fast Generation Constraints: Enabling fast generation disables some features like transparent backgrounds unless explicitly allowed. Misconfiguration may cause errors.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.

Common error messages usually relate to invalid parameters or authentication failures. Checking the exact API response message helps identify the root cause.

Links and References

Discussion