Skip to navigation
REST API ReferenceEndpointsProjects

Inspect an editable video

Read revision-bound authored timeline structure in bounded pages. With no selector, page section summaries. Supply sectionId for layers, layerId for assets, or assetId for stored transcript words and source timings before trim/playback. offset and limit apply to the selected level. textOffset pages long text in 512-character slices. Missing composed frames and audio are identified explicitly; this read does not render or generate media.

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}$"

Query parameters

limitintegerOptional1-100Defaults to 20
offsetintegerOptional>=0Defaults to 0
sectionIdstringOptional
layerIdstringOptional
assetIdstringOptional
expectedRevisionintegerOptional>=0
Captured inspection revision. A changed revision conflicts rather than combining pages from different versions.
textOffsetintegerOptional>=0

Response

Current authorized result.
projectIdstring
editableVideoIdstring
revisioninteger0-9007199254740991
aspectRatioobject
captionStyleobject
globalLayerslist of objects
totalGlobalLayersinteger-9007199254740991-9007199254740991
nextGlobalLayersOffsetinteger or null-9007199254740991-9007199254740991
pageKindenum
Allowed values:
totalItemsinteger-9007199254740991-9007199254740991
offsetinteger-9007199254740991-9007199254740991
textOffsetinteger-9007199254740991-9007199254740991
totalSectionsinteger-9007199254740991-9007199254740991
nextOffsetinteger or null-9007199254740991-9007199254740991
evidenceobject
sectionslist of objects