VideoGen Python SDK

Official Python client for the VideoGen API.

Package: videogen (PyPI) · Import: videogen · Version: 2.0.0

Install

pip install videogen

For local development from this repo:

cd sdk-python
python -m venv .venv
source .venv/bin/activate
pip install -e .

Quick start

import os
from videogen import VideoGen

vg = VideoGen(api_key=os.environ["VIDEOGEN_API_KEY"])

run = vg.workflows.script_to_video_and_wait(
    script="Staying hydrated keeps your body and mind running at their best.",
    visual_style={
        "type": "AI_IMAGE",
        "ai_style": "loose watercolor illustration with visible brushstrokes",
    },
    quality="HIGH",
    remix_actions=[
        {"type": "ENABLE_CAPTIONS"},
        {
            "type": "CONVERT_IMAGES_TO_VIDEOS",
            "motion_prompt": "slow cinematic push-in",
            "mute_output_videos": True,
            "quality": "HIGH",
        },
    ],
)
print(run["status"], run.get("project_id"))

Async twin:

from videogen import AsyncVideoGen

vg = AsyncVideoGen(api_key=os.environ["VIDEOGEN_API_KEY"])
run = await vg.workflows.script_to_video_and_wait(script="...")

Default base URL: https://api.videogen.io. Omit api_key to read VIDEOGEN_API_KEY from the environment.

Naming and JSON

• Methods: snake_case (script_to_video, get_tool_execution_info).
• Requests: pass snake_case kwargs (and nested dict keys). The client serializes body/query keys to camelCase for the wire.
• Responses: JSON objects are converted recursively to snake_case keys so Python callers use idiomatic names (tool_execution_id, workflow_run_id, has_more).

Resources

account · workflows · projects · tools · files · assistant · text · resources · webhooks

Every public REST operation is a thin method (see @sdk-operation markers). Convenience helpers are exported as module functions and bound on the client:

*_and_wait wrappers on tools, workflows, projects, and assistant start work and poll to completion.

Cancellation

Pass cancel_event=threading.Event() (sync) or asyncio.Event() (async) to poll helpers or thin request / resource methods. Setting the event raises PollCancelledError.

Errors

VideoGenError exposes status, body, and request_id (from x-request-id when present).