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: t2v, i2v, i2v-E.Vimoo 1.0 - Lite: ti2v only.contentarray[object]Yesscene has different requirements for the number, type, and role of text and image itemscontent[].typestringYestext: Text prompt, provided in text.image_url: Image reference, provided in image_url.url, with its purpose specified by role.content[].textstringFor text itemst2v, i2v, ti2v: Required and cannot be empty.i2v-E: Optional.content[].image_urlobjectFor imagescontent[].image_url.urlstringFor images<YOUR_IMAGE_URL> with the image file_url returned by Upload a File or List Files.content[].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 imagesdurationintegerYesi2v-E: Fixed at 20 seconds.t2v, i2v, and ti2v: Fixed at 5 seconds.seedintegerNo0 to 9999999999999. Default: 42 when omitted. Use a different seed to generate a different result.ratiostringYesi2v-E: 9:16.t2v: 16:9.i2v: auto.ti2v: auto with an image; 16:9 without an image.resolutionstringYesi2v-E and ti2v: 720p only.t2v and i2v: 720p or 1080p.audio_languagestringNoExample 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.