REST API ReferenceEndpointsWorkflows

Voiceover to video

Creates a project from an uploaded voiceover file and generates a video with matching b-roll. Upload the voiceover via the files API first.

Authentication

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

Request

This endpoint expects an object.
fileIdstringRequired

Opaque file id of an uploaded voiceover audio file (e.g. vg_file_...). Upload the file first via POST /v1/files/upload. Attach a pre-computed transcript at upload time (via the transcript field on POST /v1/files/upload) to skip re-transcription.

visualStyleobjectRequired

Visual style for the generated b-roll.

sceneslist of objectsOptional

Optional timed scene descriptions guiding what to show on screen during each absolute time range of the video. Ranges must be sorted by startSeconds and non-overlapping. Omit to let the workflow choose visuals automatically.

aspectRatioobjectOptional

Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel dimensions.

visualPacingenumOptionalDefaults to MEDIUM

How quickly visuals change. FAST shows more, shorter shots; SLOW holds each visual longer. Defaults to MEDIUM.

qualityenumOptional

Image generation quality tier for AI-generated visuals. Optional; when omitted, your workspace’s Default AI quality for images is used (change it at https://app.videogen.io/settings/account). Only applies when visualStyle.type is AI_IMAGE or ENTITY; STOCK pulls existing footage and is unaffected.

languagestringOptional

Output language as a BCP-47 code (e.g. en, es, fr). Defaults to English.

captionStyleobject or nullOptional

Caption styling. Omit to use the default style with captions shown. Pass an object to override individual style fields (any omitted field uses the default). Pass null to hide captions entirely.

logoFileIdstring or nullOptional

Optional file id of an uploaded logo image to overlay on the video (e.g. vg_file_...). Upload the image first via POST /v1/files/upload. Only image files are accepted.

workflowAgentContextstringOptional

Optional production notes for the AI that builds the video — visual direction for how to illustrate the voiceover (e.g. on-screen code or text to display, specific b-roll to feature, or scene-by-scene staging). Never spoken; does not change the uploaded voiceover audio or its transcript.

remixActionslist of objectsOptional

Optional edits applied to the project after the video is built, in order. Each action runs asynchronously; the response returns one remix action id per action. Captions and a logo are set with the captionStyle and logoFileId request fields above; recommended remix actions here are CONVERT_IMAGES_TO_VIDEOS to animate still images into clips, and ADD_TRANSITIONS to stamp transitions between sections and assets. See the Remix actions guide.

isOutputTemporarybooleanOptionalDefaults to false

When true, the video’s generated OUTPUT files (AI images, video clips, voiceover audio, avatars) are created as temporary: guaranteed available for 24 hours, after which they may be archived and later deleted. This also covers files produced by post-build remix actions (e.g. generated background music, image-to-video conversions). 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.