openai-agents-videogen
Official OpenAI Agents SDK tools for the VideoGen API. Give any OpenAI Agents SDK 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 openai-agents-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
import asyncio
from agents import Agent, Runner
from openai_agents_videogen import create_videogen_tools
agent = Agent(
name="Video Producer",
instructions="You produce short narrated videos with VideoGen when asked.",
tools=create_videogen_tools(),
)
async def main() -> None:
result = await Runner.run(
agent,
"Make a short narrated video explaining why staying hydrated matters.",
)
print(result.final_output)
asyncio.run(main())
By default each tool blocks until the workflow or tool execution finishes and returns the completed result.
Options
from videogen import VideoGen
from openai_agents_videogen import create_videogen_tools
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 agent.
include=["script_to_video", "generate_image", "text_to_speech"],
)
| 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 permissions
Generation and editing use VideoGen account credits. Obtain user approval before credit-consuming calls, and restrict the include list for agents that only need read access. Keep API keys in environment variables and out of shared transcripts.
2.5.4
Fix polling after workflow, media-tool and export starts to use the Python SDK’s normalized response keys. No API capabilities or dependency requirements changed.
Metadata
Release files for openai-agents-videogen 2.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| openai_agents_videogen-2.5.4.tar.gz | 12.8 kB | Without provenance | Details for openai_agents_videogen-2.5.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| openai_agents_videogen-2.5.4-py3-none-any.whl | Python 3 | none | any | Details for openai_agents_videogen-2.5.4-py3-none-any.whl |
Total release size: 26.5 kB
Release files / openai_agents_videogen-2.5.4.tar.gz
| Download URL | openai_agents_videogen-2.5.4.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3c6c78f93114397fb092fa143ba7952681a7e8510783ef202b6cb825f2bfbb90
|
|
BLAKE2b-256 checksum How to use checksums |
23e5650217483073b521463fe66e26128bb7f760abad6a01098ece00588ac4c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.4
|
Release files / openai_agents_videogen-2.5.4-py3-none-any.whl
| Download URL | openai_agents_videogen-2.5.4-py3-none-any.whl |
|---|---|
| Size | 13.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3299408ff9df8ea18de6fdac2cf25bfb46d9261356a3fc1d49e9751683fec91f
|
|
BLAKE2b-256 checksum How to use checksums |
4273e1a3bc117a737109ab438f81216ad63b903554a9b73c7d29b06faac60c25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.4
|
Security for openai-agents-videogen 2.5.4
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.