API Documentation

List Tasks

GET/vimoo/api/v1/video-generation-tasks

AuthorizationHeader · RequiredGet an API Key ↗

Retrieve a paginated list of video generation tasks for the current account, with filters for creation time, task identifier, and model.

created_fromintegerNo: Inclusive start of the creation-time range, as a Unix timestamp in seconds
created_tointegerNo: Inclusive end of the creation-time range, as a Unix timestamp in seconds. When provided with created_from, it must not be earlier than created_from
task_nostringNo: Filter by an exact match on the full task identifier
modelstringNo: Filter by model. Supported values are Vimoo 1.0 and Vimoo 1.0 - Lite. Omit to return all models
offsetintegerNo: Non-negative pagination offset; defaults to 0
limitintegerNo: Number of items per page, from 1 to 100; defaults to 20

tasksarray[object]: Tasks sorted by creation time in descending order. See Get Task Results for task fields. Returns an empty array when no tasks match
totalinteger: Total number of tasks matching the current filters

Example successful response (excerpt):

See Responses and Error Codes for error response formats and error codes.