Jump to content

Connect SuperML | Leeroopedia MCP: Equip your AI agents with best practices, code verification, and debugging knowledge. Powered by Leeroo — building Organizational Superintelligence. Contact us at founders@leeroo.com.

Implementation:Openai Openai python Video List Params

From Leeroopedia
Revision as of 13:41, 16 February 2026 by Admin (talk | contribs) (Auto-imported from implementations/Openai_Openai_python_Video_List_Params.md)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Knowledge Sources
Domains API_Types, Python
Last Updated 2026-02-15 00:00 GMT

Overview

Concrete tool for specifying pagination and ordering parameters when listing Video generation jobs via the OpenAI API, provided by the openai-python SDK.

Description

VideoListParams is a TypedDict that defines the optional parameters for listing video generation jobs. It supports cursor-based pagination with after (an identifier for the last item from the previous request), a limit on the number of items to retrieve, and an order field to sort results by timestamp in ascending or descending order.

Usage

Import this type when you need to type-annotate keyword arguments for client.videos.list() or when building parameter dictionaries for paginated listing of video jobs.

Code Reference

Source Location

Signature

class VideoListParams(TypedDict, total=False):
    after: str
    limit: int
    order: Literal["asc", "desc"]

Import

from openai.types import VideoListParams

I/O Contract

Fields

Name Type Required Description
after str No Identifier for the last item from the previous pagination request.
limit int No Number of items to retrieve.
order Literal["asc", "desc"] No Sort order of results by timestamp. "asc" for ascending, "desc" for descending.

Usage Examples

from openai import OpenAI
from openai.types import VideoListParams

client = OpenAI()

params: VideoListParams = {
    "limit": 20,
    "order": "desc",
}

page = client.videos.list(**params)
for video in page.data:
    print(video.id, video.status, video.progress)

Related Pages

Page Connections

Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment