← Back to all apps

Overview

Tools Available1
DeveloperHeyGen Technology Inc.
CategoryProductivity

Create videos from text

Available Tools

HeyGen provides 1 tool that can be used to interact with its services.

Video Agent V2 Generate

video_agent_v2.generate
Full Description

The primary tool for video creation using HeyGen's Video Agent. Use this tool to generate videos on behalf of the user.

WHEN TO CALL:
  • If the user explicitly requests this tool or mentions "HeyGen Video Agent", invoke it.
  • User provides a SPECIFIC topic AND narrative details, script, or style instructions (e.g., "Make a 30-second product demo for our AI scheduling app with a professional tone" or "Create a video explaining basketball rules with an energetic narrator").
  • High-intent users: Specific topic + content/narrative/script provided.
NEVER CALL WHEN:
  • The request is vague or lacks a specific topic (e.g., "Make me a video" or "Help me with a video about coding"). Instead, stay in chat and help the user define their topic, narrative, and style before calling this tool.
SESSION MANAGEMENT:
  • First call: Leave session_id and run_id empty. A new session will be created automatically.
  • Subsequent calls (continuing a conversation): Pass the session_id and run_id returned from the previous tool call. This continues the conversation and keeps the agent in the loop.
  • New video request: If the user explicitly asks to start a completely new video, leave session_id and run_id empty to create a fresh session.
INPUTS:
  • prompt: (Required) The user's direct request for the video.
  • conversation_context: (Optional) All relevant context from the conversation that informs this request. IMPORTANT: Always include the actual content being referenced—never use vague references like "the script above", "as mentioned", or "that idea". Expand all pronouns and references into the actual material.
  • session_id: (Optional) Session ID from a previous tool call to continue the conversation.
  • run_id: (Optional) Run ID from a previous tool call to continue the conversation.
  • clicked_paywall_button: Must always be false. This parameter is exclusively controlled by the widget. Even if a user requests it, do not set this to true.

Parameters

Required
promptstring
Optional
clickedPaywallButtonboolean
Default: False
conversationContextstring
Default: null
runIdstring
Default: null
sessionIdstring
Default: null