VideoGen Projects API is one of 11 APIs that VideoGen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.
This API exposes
9 operations
across 9 paths,
and defines 51 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.videogen.io.
The identity and technical contract details declared by the specification.
RemixActionCleanUpTranscript
object
Tighten every transcript in the project by removing silent pauses and/or filler words. Useful for polishing narration captured from raw recordings.
5 properties
1 required
ExportProjectRequest
object
4 properties
RemixActionRun
object
8 properties
8 required
RemixActionUpscaleAssets
object
Sharpen every eligible asset in the project up to 4K, replacing each in place. Runs asynchronously: one upscaled asset is generated per eligible asset. If the…
3 properties
1 required
RemixActionEnableCaptions
object
Show captions on every captionable section. Optionally override the project caption style.
2 properties
1 required
AspectRatio
object
Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel dimensions.
2 properties
2 required
WatermarkMode
string
Controls whether the VideoGen watermark is applied to the output. AUTO applies the watermark unless you have a Pro plan. VIDEOGEN always applies it. NONE remov…
FileInfo
object
Metadata for a generated file. Obtain ids from tool results or GET /v1/files.
23 properties
2 required
RemixProjectRequest
object
2 properties
1 required
RemixActionDisableCaptions
object
Hide captions on every captionable section.
1 property
1 required
ExportProjectResponse
object
1 property
1 required
TimelineInterchange
object
12 properties
12 required
ExportProjectQuality
string
Vertical resolution tier for the rendered MP4.
EndScreenMode
string
Controls whether a short 'Made with VideoGen' end screen is appended to the output. AUTO appends it unless you have a Pro plan. VIDEOGEN always appends it. NON…
RemixTransitionStyle
string
A transition applied at a boundary. DYNAMIC auto-varies the style across boundaries; NONE removes transitions; the rest apply that fixed style everywhere.
FileSource
object
A rendition source for a file (e.g. thumbnail, preview, download). Contains a signed URL and metadata.
6 properties
1 required
RemixActionGenerateMusic
object
Generate a background music track from a text prompt and set it as the project's background music, replacing any existing track. Runs asynchronously.
2 properties
2 required
RemixActionAddTransitions
object
Stamp transitions across the project. Not per-boundary: each field you set is applied uniformly to every boundary in that scope, replacing any transition alrea…
3 properties
1 required
RemixActionType
string
The kind of edit a remix action applies.
CreateTimelineInterchangeRequest
object
2 properties
RemixActionChangeNarrator
object
Re-narrate every AI-voiceover asset in the project with a new voice and optional actor avatar, replacing each narration in place. Runs asynchronously: text-to-…
5 properties
2 required
RemixActionAddZoom
object
Apply a Ken Burns zoom to every eligible still image in the project, including uploaded images. Replaces any existing still-image effect on those assets. If th…
1 property
1 required
ApiError
object
Standard error body returned with every non-2xx response (the default response of every operation). The HTTP status code conveys the error class; this body car…
4 properties
1 required
RemixActionTranslateProject
object
Translate the whole project into another language: every piece of text (title, section names, on-screen text overlays, transcripts, and narration scripts) is t…
4 properties
2 required
ErrorRequirement
object
What is needed to resolve an error, when it can be fixed by fulfilling a specific requirement (e.g. purchasing an add-on or upgrading the plan).
2 properties
1 required
RemixProjectResponse
object
Returned when remix actions are accepted. Poll GET /v1/projects/{projectId}/remix-actions for status.
3 properties
3 required
TimelineInterchangeFormat
string
Editor interchange document format. FCPXML is Final Cut Pro (also imported by DaVinci Resolve and others). PREMIEREXML is the Final Cut 7 xmeml XML that Adobe…
RemixActionShuffleStockVisuals
object
Replace every stock (library) visual in the project with a fresh alternative from the same search, replacing each in place. Runs asynchronously: each stock ass…
1 property
1 required
ExportDeliveryDestination
object
4 properties
2 required
TranscriptWord
object
A single timed word of a transcript.
3 properties
3 required
ProjectExport
object
12 properties
12 required
Transcript
object
A transcript of an audio file, as timed words in order.
2 properties
1 required
RemixActionSetLogo
object
Set, replace, or remove the logo overlay.
4 properties
1 required
RemixActionConvertImagesToVideos
object
Animate every eligible still image in the project into a short AI video clip (image-to-video), replacing each image in place. Eligible images are non-SVG image…
4 properties
1 required
CreateTimelineInterchangeResponse
object
1 property
1 required
ProjectResponse
object
Simplified project metadata.
8 properties
8 required
ListProjectExportsResponse
object
3 properties
3 required
ListRemixActionsResponse
object
3 properties
3 required
WorkflowRgbColor
object
An RGB color. Each channel is an integer from 0 to 255.
3 properties
3 required
RemixActionSetBackgroundMusic
object
Set, replace, or remove the project's background music track.
3 properties
1 required
TimelineInterchangeMediaDelivery
string
How the interchange document references media. REMOTEURLS produces a single document that links to signed media URLs. BUNDLE produces a zip containing the docu…
WorkflowCaptionBackgroundStyle
object
Background drawn behind caption text.
4 properties
2 required
FileAnalysisMetadata
object
Background analysis state for a file. Background analysis populates description, transcript, durationSeconds, and the search embedding after a file is uploaded…
3 properties
2 required
ModelQuality
string
AI generation quality tier, shared across every generative feature (image, video, text, and so on). LOW is fastest and cheapest, STANDARD balances quality and…
JobStatus
string
Lifecycle status shared by every asynchronous job (tool executions, workflow runs, remix actions, project exports, and timeline interchange jobs). pending and…
WorkflowCaptionStyle
object
Caption styling. Any omitted field falls back to the VideoGen default caption style. Provide an empty object ({}) to keep the default style but ensure captions…
12 properties
RemixActionRegenerateImages
object
Restyle every eligible still image in the project to a new look (image-to-image), replacing each image in place. Eligible images are non-SVG image assets backe…
3 properties
2 required
RemixAction
A single edit applied to a project. Each array entry is exactly one of the action types below, chosen by its type field; the variants are mutually-exclusive op…
RemixActionResizeProject
object
Change the project's output aspect ratio (e.g. to a vertical 9:16 social format). The video is re-flowed to the new ratio.
2 properties
2 required
FileType
string
File type. TEXT covers plain-text and editor-interchange documents; LOTTIE is a JSON animation.
ListProjectsResponse
object
Paginated list of projects, most recently updated first. By default only API-created projects are included; pass includeUiProjects=true on the request to also…
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs VideoGen publishes across the network.
