API Documentation
Create a Generation Task
POST
/vimoo/api/v1/video-generation-tasksLoading...
/vimoo/api/v1/video-generation-tasksLoading...
Submit a video generation task. On success, the API returns task_no; retrieve the task status and generated result through Get Task Results.
modelstringYesVimoo 1.0 and Vimoo 1.0 - LitescenestringYesVimoo 1.0 supports t2v, i2v, and i2v-E; Vimoo 1.0 - Lite supports only ti2vcontentarray[object]Yesscene has different requirements for the number, type, and role of text and image itemscontent[].typestringYestext: Text content; provide the prompt in textimage_url: Image content; provide the image URL in image_url.url and specify its purpose with rolecontent[].textstringFor text itemsscene is t2v, i2v, or ti2v; may be omitted or left empty when scene is i2v-E. After trimming leading and trailing whitespace, the prompt may contain up to 2,000 characters; internal spaces and line breaks count toward the limitcontent[].image_urlobjectFor imagescontent[].image_url.urlstringFor imagesfile.file_url returned by Upload a File. Only valid images uploaded by the current account are supportedcontent[].rolestringRequired for imagesfirst_frame: For scene=i2v or scene=ti2v. i2v requires exactly 1 image; ti2v accepts an optional single imagereference_image: For scene=i2v-E, with 1–9 imagesdurationintegerYest2v, i2v, and ti2v are fixed at 5 seconds; i2v-E is fixed at 20 secondsseedintegerNo0 to 2147483647. Defaults to 42 when omitted; an explicit 0 is preservedratiostringYes16:9 for t2v, auto for i2v, auto or 16:9 for ti2v, and 9:16 for i2v-EresolutionstringYes720pExample successful response (excerpt):
Save task_no to retrieve the task details and status later. For the complete task fields, see Get Task Results.
Preserve request_id for failed write requests and confirm that no task was created before retrying.
task_nostringSee Responses and Error Codes for error response formats and error codes.