Skip to main content

​
start

Method
This is a method of the VideoAgent class in the video_agent module.
Generate video with optional wait and file output. Beginner-friendly method that handles the full workflow:
  1. Generate video
  2. Wait for completion (if wait=True)
  3. Download and save to file (if output is specified)

​
Signature

def start(prompt: str, wait: bool, output: Optional[str]) -> Union[Any, bytes]

​
Parameters

​
prompt
str
required
Text description of the desired video
​
wait
bool
default:"True"
If True, wait for completion before returning
​
output
Optional
Path to save the video file (e.g., “video.mp4”) **kwargs: Additional parameters for generate()

​
Returns

​
Returns
Union[Any, bytes]
VideoObject with initial status
  • If wait=True and output: bytes (video content)
  • If wait=True and no output: VideoObject with completed status

​
Usage

# Full workflow with file output
    video = agent.start(
        prompt="A serene lake at sunset",
        wait=True,
        output="sunset.mp4"
    )

    # Just generate (don't wait)
    video = agent.start(
        prompt="A cat playing",
        wait=False
    )
    print(f"Video ID: {video.id}")  # Poll later with status()