REST API ReferenceEndpointsWorkflows

Prompt to video clip

Creates a project from a text prompt and generates one short AI video clip (up to 15 seconds). VideoGen first generates an opening frame from the prompt (optionally guided by reference images), then animates that frame into a video. Returns immediately with a workflow run id; poll or subscribe to webhooks for completion. For a standalone clip without an editable project, use `POST /v1/tools/generate-video-clip` instead. For longer narrated multi-scene videos, use `POST /v1/workflows/script-to-video`.

Authentication

AuthorizationBearer
API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Request

This endpoint expects an object.
promptstringRequired

Text prompt describing the video to generate (e.g. A golden retriever running through a sunlit meadow in slow motion, cinematic).

imageFileIdslist of stringsOptional

Optional ids of previously uploaded reference images (e.g. vg_file_...) that guide the opening frame. Upload files via POST /v1/files/upload first.

durationSecondsintegerOptional1-15

Desired clip length in whole seconds (1 to 15). Defaults to 10.

aspectRatioobjectOptional

Aspect ratio for the generated video. Defaults to 16:9 when omitted.

qualityenumOptional

Video generation quality tier. Also used for the opening-frame image. Optional; when omitted, your workspace’s Default AI quality for video is used (change it at https://app.videogen.io/settings/account). LOW is not supported for video and is rejected.

isOutputTemporarybooleanOptionalDefaults to false

When true, the generated OUTPUT files (the opening-frame image and the video clip) are created as temporary: guaranteed available for 24 hours, after which they may be archived and later deleted. Use this when your integration downloads or re-hosts the results itself and does not need VideoGen to retain them. The project and its metadata are unaffected. Defaults to false.

Response

Workflow run accepted.
workflowRunIdstring

Opaque workflow run id (e.g. vg_work_...).

projectIdstring

Id of the project created for this workflow run (e.g. vg_proj_...).

projectUrlstringformat: "uri"

Deep link to open this project in the VideoGen web editor. Not required for an API-only integration: store projectId and use the Projects API (export, remix, metadata). Use projectUrl when a person should open the project in the app to review or edit it manually. The project is visible only to members of your team and any project collaborators, the same access model as a project created in the dashboard.

remixActionIdslist of strings

Opaque remix action ids (e.g. vg_rmix_...), one per remixActions entry in request order. Empty when no remix actions were requested. Each runs after the video is built; poll GET /v1/projects/{projectId}/remix-actions.