REST API ReferenceEndpointsWorkflows

Add narration, transitions, and captions to a slideshow

Creates a project from an uploaded PDF or PowerPoint file and generates an AI-narrated video walking through each slide. Upload the file via POST /v1/files/upload first.

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.
fileIdstringRequired

Opaque file id of an uploaded PDF or PowerPoint file (e.g. vg_file_...). Upload the file first via POST /v1/files/upload.

slideScriptslist of stringsOptional

Optional per-slide narration, in slide order, applied by index: each slide uses its matching entry, and an empty string makes that slide silent. If you provide fewer entries than slides, the remaining slides are silent; extra entries are ignored. Omit this field entirely to narrate each slide from its speaker notes in the uploaded file. To guarantee no narration on any slide, pass an empty array.

aspectRatioobjectOptional

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

languagestringOptional

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

voiceIdstring or nullOptional

Voice id from GET /v1/resources/tts-voices (e.g. vg_voic_...). A default voice is used when omitted. Any voice may be used here, including voices where supportsDirectToolExecution is false.

voiceSpeeddoubleOptional
Speech rate multiplier. Defaults to the voice's default speed.
avatarPresenterIdstring or nullOptional

Optional avatar presenter id from GET /v1/resources/avatar-presenters (e.g. vg_pres_...). When set, the narration is delivered by a talking-head presenter avatar. Pass your voiceId to that endpoint to list presenters sorted by best match for the voice. Omit for a standard voiceover with no presenter.

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.

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. Use this for background music, logo overlays, or caption changes beyond captionStyle.

Response

Workflow run accepted.
workflowRunIdstring

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

projectIdstring
Id of the project created for this workflow run.
projectUrlstringformat: "uri"
URL to view the project in the VideoGen app.
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.