Skip to navigation
REST API ReferenceEndpointsProjects

Edit a video

Apply a bounded batch of typed immediate edits to this specific editable video, or start one background edit on it. Supply the inspected expectedRevision and a fresh mutationId UUID. Retry the same request unchanged to recover its original receipt. Immediate edits save at once and do not generate media or export. A background command (logo, transitions, zoom, transcript cleanup, image animation or restyle, upscale, narrator change, stock shuffle, generated music, translation, added or draft media, or a tool on one asset) must be sent alone. It returns outcome STARTED with a videoEditId to follow through GET /v1/projects/{projectId}/video-edits. Paid background commands spend credits.

Authentication

AuthorizationBearer

API key from app.videogen.io/api. The full key is only shown once when you create it.

Path parameters

projectIdstringRequiredformat: "^vg_proj_[0-9A-Za-z]{22}$"
editableVideoIdstringRequiredformat: "^vg_vide_[0-9A-Za-z]{22}$"

Request

This endpoint expects an object.
mode"COMMANDS"Required
mutationIdstringRequiredformat: "uuid"
expectedRevisionintegerRequired0-9007199254740991
commandslist of objectsRequired

Immediate commands save together. A background command (logo, transitions, zoom, transcript cleanup, generation, translation, added or draft media, asset tools) must be the only command in its request and starts a background task.

Response

Current authorized result.
projectIdstring
mutationIdstringformat: "uuid"
outcomeenum
Allowed values:
projectRevisioninteger0-9007199254740991
editableVideoIdstringOptional
videoEditIdstringOptional

Present when outcome is STARTED. Follow this id in GET /v1/projects/{projectId}/video-edits.