Skip to main content

llama-index-tools-videogen

Official LlamaIndex tools for the VideoGen API. Give any LlamaIndex agent the ability to turn a script into a finished narrated video, plus generate standalone images, video clips, voiceovers, sound effects, music, and talking-head avatars.

Every tool wraps the official videogen SDK and runs as the team that owns your API key.

Install

pip install llama-index-tools-videogen

Setup

Get an API key from app.videogen.io/api and set it as VIDEOGEN_API_KEY:

export VIDEOGEN_API_KEY="your_api_key"

Usage

from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI
from llama_index.tools.videogen import create_videogen_tools

agent = FunctionAgent(
    tools=create_videogen_tools(),
    llm=OpenAI(model="gpt-4o"),
    system_prompt="You produce short narrated videos with VideoGen when asked.",
)

response = await agent.run(
    "Make a short narrated video explaining why staying hydrated matters."
)
print(response)

By default each tool blocks until the workflow or tool execution finishes and returns the completed result.

Options

from videogen import VideoGen
from llama_index.tools.videogen import create_videogen_tools, VideoGenToolSpec

tools = create_videogen_tools(
    # Provide a pre-configured client, or pass api_key / base_url, or rely on env.
    client=VideoGen(api_key="your_api_key"),

    # Return the run/execution id immediately instead of waiting.
    wait=False,

    # Only expose a subset of tools to the model.
    include=["script_to_video", "generate_image", "text_to_speech"],
)

# Or use the tool spec:
tools = VideoGenToolSpec().to_tool_list()
Option Default Description
client — A pre-configured VideoGen client.
api_key VIDEOGEN_API_KEY API key used to build a client when client is omitted.
base_url VIDEOGEN_BASE_URL or production Override the API base URL.
wait True Block until the operation finishes and return the result.
poll_interval_ms SDK default Poll interval while waiting.
timeout_ms SDK default Maximum time to wait before giving up.
include all tools Restrict the returned tool set to these tool names.

Tools

  • Workflows: cancel_workflow_run, get_workflow_run, list_workflow_runs, prompt_to_video_clip, script_to_video, slideshow_to_video, storyboard_to_video, video_to_video, voiceover_to_video.
  • Media generation: cancel_tool_execution, generate_avatar, generate_image, generate_motion_graphic, generate_music, generate_sound_effect, generate_video_clip, get_tool_execution, image_3d_effect, list_tool_executions, remove_image_background, remove_video_background, text_to_speech, upscale_image, upscale_video, vectorize_image.
  • Projects: export_project, get_project, list_project_remix_actions, list_projects, remix_project.
  • Files: get_file, list_files, upload_file.
  • Resources and account: get_me, list_languages, list_tts_voices.

Avatar generation and supported video workflows use reusable actor entities. Pass actor_entity_id and set avatar_quality to LOW, STANDARD, HIGH, or MAX. Narrator changes are passed in remix_actions as CHANGE_NARRATOR action dictionaries.

Documentation

License

MIT

Account and tool permissions

Generation uses your VideoGen account credits. Obtain user approval before invoking generation, editing or export tools. Start with a restricted include list when an agent only needs read access. File upload tools send the selected file to VideoGen; keep API keys in server-side environment variables and never place them in shared agent transcripts.

For a credential-free smoke check, build the tools with a synthetic key without invoking them. The package tests mock or avoid external calls; they do not prove paid generation.

VideoGen · MCP setup

Metadata

Release files for llama-index-tools-videogen 2.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-tools-videogen 2.5.0
File Size Uploaded Provenance Actions
llama_index_tools_videogen-2.5.0.tar.gz 13.2 kB Without provenance Details for llama_index_tools_videogen-2.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-tools-videogen 2.5.0
File Interpreter ABI Platform Actions
llama_index_tools_videogen-2.5.0-py3-none-any.whl Python 3 none any Details for llama_index_tools_videogen-2.5.0-py3-none-any.whl

Total release size: 28.0 kB

Release files / llama_index_tools_videogen-2.5.0.tar.gz

Download URL llama_index_tools_videogen-2.5.0.tar.gz
Size 13.2 kB
Tags Source
SHA-256 checksum
How to use checksums
26735648e0025332e374b0bf10c3d28c11395943fd80a4039c3eaad3a6234b4c
BLAKE2b-256 checksum
How to use checksums
480861ab80fc2e8accdf190cb57b3d1819f4f8fc6d6621d01993ea2ccccda100
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.4

Release files / llama_index_tools_videogen-2.5.0-py3-none-any.whl

Download URL llama_index_tools_videogen-2.5.0-py3-none-any.whl
Size 14.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dc5e82848194259ddba028f1b8c9590e1e496c6f894c73c9da1ccf26e5a2c470
BLAKE2b-256 checksum
How to use checksums
59fbc521a115b2c74f5f8dc5fd1e335783925726869b746db674bbfb9ab75e9b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.4

Security for llama-index-tools-videogen 2.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.5.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page