VIvideogen
Workflows

Prompt to video clip

Changed on

Creates a project from a text prompt and generates one short AI video clip (up to 30 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. The generated clip is clamped to the selected quality's supported range.

post/v1/workflows/prompt-to-video-clip

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Request body

promptstring required

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

imageFileIdsstring[]

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

durationSecondsinteger

Desired clip length in whole seconds (1 to 30). Defaults to 10. The generated clip is clamped to the selected quality's supported range.

quality'LOW' | 'STANDARD' | 'HIGH' | 'MAX'

AI generation quality tier, shared across every generative feature (image, video, text, and so on). LOW is fastest and cheapest, STANDARD balances quality and cost, HIGH is higher quality, and MAX is the highest quality.

When a request omits the quality field, VideoGen falls back to your account's Default AI quality for that feature, which you can change at Account settings. Not every feature supports every tier; unsupported tiers are rejected with an error (see each field's description).

isOutputTemporaryboolean

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.

autoExportboolean

When true, VideoGen exports an MP4 after the video is built (and after any remixActions on this request finish). The workflow run stays running until that export succeeds or fails. On success, poll GET /v1/workflows/runs/{workflowRunId} and use downloadUrl. Defaults to false.

Response

Workflow run accepted.

workflowRunIdstring required

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

projectIdstring required

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

projectUrlstring uri required

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.

remixActionIdsstring[] required

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.

Changes