Video
Start, poll and download video generation jobs
Video generation is slow, so video_generation returns a VideoJob rather than a video. retrieve_video reads the job again, poll_video waits for it, and download_video fetches the result. complete_video_job finishes a job from the callback a provider posted to your webhook. See Video Generation for the providers and what each one takes.
Start a job
any_llm.video_generation()
def video_generation(
model: str,
prompt: str,
*,
provider: str | LLMProvider | None = None,
seconds: int | None = None,
size: str | None = None,
resolution: str | None = None,
aspect_ratio: str | None = None,
seed: int | None = None,
negative_prompt: str | None = None,
reference_images: list[str] | None = None,
reference_audios: list[str] | None = None,
reference_videos: list[str] | None = None,
first_frame: str | None = None,
last_frame: str | None = None,
generate_audio: bool | None = None,
api_key: str | None = None,
api_base: str | None = None,
client_args: dict[str, Any] | None = None,
**kwargs: Any,
) -> VideoJobany_llm.avideo_generation()
Async variant with the same parameters.
Parameters
model
str
required
Model identifier. Recommended: Use with separate provider parameter (e.g., model='ByteDance/Seedance-2.0', provider='together'). Alternative: Combined format 'provider:model' (e.g., 'together:ByteDance/Seedance-2.0').
prompt
str
required
A text description of the desired video.
provider
str | LLMProvider | None
None
Provider name to use for the request (e.g., 'together').
seconds
int | None
None
Length of the video in seconds.
size
str | None
None
Size of the video as WIDTHxHEIGHT (e.g., '1280x720'). Not combined with the next two.
resolution
str | None
None
How sharp, by short side: '480p', '720p', '1080p' or '4k'.
aspect_ratio
str | None
None
What shape, as WIDTH:HEIGHT (e.g., '16:9').
seed
int | None
None
Seed for reproducible generation.
negative_prompt
str | None
None
What the video should not contain.
reference_images
list[str] | None
None
Image URLs the video should take its subjects or style from.
reference_audios
list[str] | None
None
Audio URLs the video should follow, for lip sync, beat-matched motion or a sound track.
reference_videos
list[str] | None
None
Video URLs the video should take its motion, subjects or style from.
first_frame
str | None
None
Image URL to start the video from.
last_frame
str | None
None
Image URL to end the video on.
generate_audio
bool | None
None
Whether the video carries a sound track. None leaves the provider's default.
api_key
str | None
None
API key for the provider.
api_base
str | None
None
Base URL for the provider API.
client_args
dict[str, Any] | None
None
Additional provider-specific arguments for client instantiation.
**kwargs
Any
required
Additional provider-specific arguments.
Read a job
any_llm.retrieve_video()
any_llm.aretrieve_video()
Async variant with the same parameters.
Parameters
provider
str | LLMProvider
required
Provider name to use for the request (e.g., 'together')
video_id
str
required
The ID of the video job to retrieve
api_key
str | None
None
API key for the provider
api_base
str | None
None
Base URL for the provider API
client_args
dict[str, Any] | None
None
Additional provider-specific arguments for client instantiation
**kwargs
Any
required
Additional provider-specific arguments
Wait for a job
any_llm.poll_video()
any_llm.apoll_video()
Async variant with the same parameters.
Parameters
provider
str | LLMProvider
required
Provider name to use for the request (e.g., 'together')
video_id
str
required
The ID of the video job to wait for
poll_interval
float
5.0
Seconds to wait between retrievals
timeout
float | None
600.0
Seconds to wait in total before giving up, or None to wait forever
api_key
str | None
None
API key for the provider
api_base
str | None
None
Base URL for the provider API
client_args
dict[str, Any] | None
None
Additional provider-specific arguments for client instantiation
**kwargs
Any
required
Additional provider-specific arguments passed to each retrieval
Download a video
any_llm.download_video()
any_llm.adownload_video()
Async variant with the same parameters.
Parameters
provider
str | LLMProvider
required
Provider that generated the video (e.g., 'together')
output
VideoOutput
required
One entry of VideoJob.outputs
api_key
str | None
None
API key for the provider
api_base
str | None
None
Base URL for the provider API
client_args
dict[str, Any] | None
None
Additional provider-specific arguments for client instantiation
**kwargs
Any
required
Additional provider-specific arguments
Finish a webhook job
any_llm.complete_video_job()
Nothing is sent to the provider, so there is no async variant.
Parameters
provider
str | LLMProvider
required
Provider that runs the job (e.g., 'deepinfra')
payload
dict[str, Any]
required
The JSON body the provider posted to the webhook
model
str | None
None
The model that rendered the job, for a callback that does not name it
api_key
str | None
None
API key for the provider
api_base
str | None
None
Base URL for the provider API
client_args
dict[str, Any] | None
None
Additional provider-specific arguments for client instantiation
Usage
Last updated