> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.videogen.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.videogen.io/_mcp/server.

# Inspect an editable video

GET https://api.videogen.io/v1/projects/{projectId}/videos/{editableVideoId}/inspection

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.

Reference: https://docs.videogen.io/rest-api-reference/projects/inspect-editable-video

## Authentication

- `Authorization` header (bearer token, required) — API key from [app.videogen.io/api](https://app.videogen.io/api). The full key is only shown once when you create it.

## Request

### Path parameters

- `projectId` (string, required)
- `editableVideoId` (string, required)

### Query parameters

- `limit` (integer, optional, default: 20)
- `offset` (integer, optional, default: 0)
- `sectionId` (string, optional)
- `layerId` (string, optional)
- `assetId` (string, optional)
- `expectedRevision` (integer, optional) — Captured inspection revision. A changed revision conflicts rather than combining pages from different versions.
- `textOffset` (integer, optional)

## Response

### 200

Current authorized result.

- `projectId` (string, required)
- `editableVideoId` (string, required)
- `revision` (integer, required)
- `aspectRatio` (EditableVideoInspectionAspectRatio, required)
- `captionStyle` (EditableVideoInspectionCaptionStyle, required)
- `globalLayers` (list of EditableVideoInspectionGlobalLayersItems, required)
- `totalGlobalLayers` (integer, required)
- `nextGlobalLayersOffset` (integer, required, nullable)
- `pageKind` (enum, required)
  - Allowed values: `SECTIONS`, `LAYERS`, `ASSETS`, `TRANSCRIPT_WORDS`
- `totalItems` (integer, required)
- `offset` (integer, required)
- `textOffset` (integer, required)
- `totalSections` (integer, required)
- `nextOffset` (integer, required, nullable)
- `evidence` (EditableVideoInspectionEvidence, required)
- `sections` (list of EditableVideoInspectionSectionsItems, required)

## Types

### EditableVideoInspectionAspectRatio

- `width` (double, required)
- `height` (double, required)

### EditableVideoInspectionCaptionStyle

- `fontFamily` (string, required)
- `fontSize` (double, required)
- `fontWeight` (double, required)
- `textColor` (string, required)
- `textAlpha` (double, required)

### EditableVideoInspectionGlobalLayersItems

- `layerId` (string, required)
- `totalAssets` (integer, required)
- `assets` (list of EditableVideoInspectionGlobalLayersItemsAssetsItems, required)

### EditableVideoInspectionEvidence

- `composedFrames` ("unavailable", required)
- `audio` ("unavailable", required)
- `source` ("timeline", required)

### EditableVideoInspectionSectionsItems

- `sectionId` (string, required)
- `totalLayers` (integer, required)
- `nextNameTextOffset` (integer, required, nullable)
- `nextDescriptionTextOffset` (integer, required, nullable)
- `name` (string, required, nullable)
- `description` (string, required, nullable)
- `outline` (EditableVideoInspectionSectionsItemsOutline, required, nullable)
- `timing` (EditableVideoInspectionSectionsItemsTiming, required)
- `layers` (list of EditableVideoInspectionSectionsItemsLayersItems, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItems

- `assetId` (string, required)
- `type` (string, required)
- `timing` (EditableVideoInspectionGlobalLayersItemsAssetsItemsTiming, required)
- `mediaType` (string, optional, nullable)
- `volume` (double, optional)
- `opacityPercent` (double, optional)
- `position` (EditableVideoInspectionGlobalLayersItemsAssetsItemsPosition, optional)
- `nextTextOffset` (integer, optional, nullable)
- `nextTtsTextOffset` (integer, optional, nullable)
- `text` (string, optional, nullable)
- `ttsText` (string, optional, nullable)
- `captionsAvailable` (boolean, optional)
- `transcript` (EditableVideoInspectionGlobalLayersItemsAssetsItemsTranscript, optional, nullable)
- `captionChunks` (EditableVideoInspectionGlobalLayersItemsAssetsItemsCaptionChunks, optional)
- `ttsEnabled` (boolean, optional)
- `fileId` (string, optional, nullable)
- `playback` (EditableVideoInspectionGlobalLayersItemsAssetsItemsPlayback, optional)
- `trim` (EditableVideoInspectionGlobalLayersItemsAssetsItemsTrim, optional)
- `fit` (EditableVideoInspectionGlobalLayersItemsAssetsItemsFit, optional)
- `appearance` (EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearance, optional)

### EditableVideoInspectionSectionsItemsOutline

- `type` (enum, required)
  - Allowed values: `TEXT_TO_SPEECH`, `SPEECH_TO_TEXT`, `NO_VOICEOVER`
- `summary` (string, required, nullable)
- `nextSummaryTextOffset` (integer, required, nullable)
- `voiceoverText` (string, required, nullable)
- `nextVoiceoverTextOffset` (integer, required, nullable)
- `direction` (string, required)
- `nextDirectionTextOffset` (integer, required, nullable)
- `speechVolume` (double, required, nullable)
- `voiceSpeed` (double, required, nullable)
- `sourceFileId` (string, required, nullable)
- `sourceTrim` (EditableVideoInspectionSectionsItemsOutlineSourceTrim, required, nullable)
- `application` ("INPUTS_ONLY", required) — Authored inputs, independent of already-generated timeline media. Editing these inputs does not regenerate that media.

### EditableVideoInspectionSectionsItemsTiming

- `startSeconds` (double, required)
- `endSeconds` (double, required)

### EditableVideoInspectionSectionsItemsLayersItems

- `layerId` (string, required)
- `totalAssets` (integer, required)
- `assets` (list of EditableVideoInspectionSectionsItemsLayersItemsAssetsItems, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsTiming

- `startSeconds` (double, required)
- `endSeconds` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsPosition

- `xStartPct` (double, required)
- `xEndPct` (double, required)
- `yStartPct` (double, required)
- `yEndPct` (double, required)
- `rotationDeg` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsTranscript

- `source` ("STORED_SOURCE_TRANSCRIPT", required)
- `trimApplied` (false, required)
- `totalWords` (integer, required)
- `words` (list of EditableVideoInspectionGlobalLayersItemsAssetsItemsTranscriptWordsItems, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsCaptionChunks

- `total` (integer, required)
- `visible` (integer, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsPlayback

- `type` (enum, required)
  - Allowed values: `CONTROLLED`, `STRETCH`
- `rate` (double, required, nullable)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsTrim

- `startSeconds` (double, required)
- `endSeconds` (double, required, nullable)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsFit

- `type` (string, required)
- `crop` (EditableVideoInspectionGlobalLayersItemsAssetsItemsFitCrop, required, nullable)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearance

- `locked` (boolean, required)
- `border` (EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceBorder, required, nullable)
- `radii` (EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceRadii, required, nullable)
- `filters` (list of EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceFiltersItems, required)
- `textStyle` (EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceTextStyle, required, nullable)
- `hasMixedTextStyles` (boolean, required)
- `shapeFill` (EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceShapeFill, required, nullable)
- `svgColors` (map from string to string, required, nullable)
- `svgColorsTruncated` (boolean, required)
- `filtersTruncated` (boolean, required)
- `enterAudioFadeSeconds` (double, required, nullable)
- `exitAudioFadeSeconds` (double, required, nullable)

### EditableVideoInspectionSectionsItemsOutlineSourceTrim

- `startSeconds` (double, required)
- `endSeconds` (double, required, nullable)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItems

- `assetId` (string, required)
- `type` (string, required)
- `timing` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTiming, required)
- `mediaType` (string, optional, nullable)
- `volume` (double, optional)
- `opacityPercent` (double, optional)
- `position` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsPosition, optional)
- `nextTextOffset` (integer, optional, nullable)
- `nextTtsTextOffset` (integer, optional, nullable)
- `text` (string, optional, nullable)
- `ttsText` (string, optional, nullable)
- `captionsAvailable` (boolean, optional)
- `transcript` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTranscript, optional, nullable)
- `captionChunks` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsCaptionChunks, optional)
- `ttsEnabled` (boolean, optional)
- `fileId` (string, optional, nullable)
- `playback` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsPlayback, optional)
- `trim` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTrim, optional)
- `fit` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsFit, optional)
- `appearance` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearance, optional)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsTranscriptWordsItems

- `chunkIndex` (integer, required)
- `wordIndex` (integer, required)
- `text` (string, required)
- `nextTextOffset` (integer, required, nullable)
- `sourceStartSeconds` (double, required)
- `sourceEndSeconds` (double, required)
- `captionsVisible` (boolean, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsFitCrop

- `xStartPct` (double, required)
- `xEndPct` (double, required)
- `yStartPct` (double, required)
- `yEndPct` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceBorder

- `width` (double, required)
- `color` (string, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceRadii

- `topLeftPercent` (double, required)
- `topRightPercent` (double, required)
- `bottomLeftPercent` (double, required)
- `bottomRightPercent` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceFiltersItems

- `type` (string, required)
- `amount` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceTextStyle

- `fontFamily` (string, required)
- `fontSize` (double, required)
- `fontWeight` (double, required)
- `textColor` (string, required)
- `textAlpha` (double, required)

### EditableVideoInspectionGlobalLayersItemsAssetsItemsAppearanceShapeFill

- `color` (string, required)
- `alpha` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTiming

- `startSeconds` (double, required)
- `endSeconds` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsPosition

- `xStartPct` (double, required)
- `xEndPct` (double, required)
- `yStartPct` (double, required)
- `yEndPct` (double, required)
- `rotationDeg` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTranscript

- `source` ("STORED_SOURCE_TRANSCRIPT", required)
- `trimApplied` (false, required)
- `totalWords` (integer, required)
- `words` (list of EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTranscriptWordsItems, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsCaptionChunks

- `total` (integer, required)
- `visible` (integer, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsPlayback

- `type` (enum, required)
  - Allowed values: `CONTROLLED`, `STRETCH`
- `rate` (double, required, nullable)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTrim

- `startSeconds` (double, required)
- `endSeconds` (double, required, nullable)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsFit

- `type` (string, required)
- `crop` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsFitCrop, required, nullable)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearance

- `locked` (boolean, required)
- `border` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceBorder, required, nullable)
- `radii` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceRadii, required, nullable)
- `filters` (list of EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceFiltersItems, required)
- `textStyle` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceTextStyle, required, nullable)
- `hasMixedTextStyles` (boolean, required)
- `shapeFill` (EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceShapeFill, required, nullable)
- `svgColors` (map from string to string, required, nullable)
- `svgColorsTruncated` (boolean, required)
- `filtersTruncated` (boolean, required)
- `enterAudioFadeSeconds` (double, required, nullable)
- `exitAudioFadeSeconds` (double, required, nullable)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsTranscriptWordsItems

- `chunkIndex` (integer, required)
- `wordIndex` (integer, required)
- `text` (string, required)
- `nextTextOffset` (integer, required, nullable)
- `sourceStartSeconds` (double, required)
- `sourceEndSeconds` (double, required)
- `captionsVisible` (boolean, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsFitCrop

- `xStartPct` (double, required)
- `xEndPct` (double, required)
- `yStartPct` (double, required)
- `yEndPct` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceBorder

- `width` (double, required)
- `color` (string, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceRadii

- `topLeftPercent` (double, required)
- `topRightPercent` (double, required)
- `bottomLeftPercent` (double, required)
- `bottomRightPercent` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceFiltersItems

- `type` (string, required)
- `amount` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceTextStyle

- `fontFamily` (string, required)
- `fontSize` (double, required)
- `fontWeight` (double, required)
- `textColor` (string, required)
- `textAlpha` (double, required)

### EditableVideoInspectionSectionsItemsLayersItemsAssetsItemsAppearanceShapeFill

- `color` (string, required)
- `alpha` (double, required)

## Examples

**Response**

```json
{
  "projectId": "string",
  "editableVideoId": "string",
  "revision": 1,
  "aspectRatio": {
    "width": 1.1,
    "height": 1.1
  },
  "captionStyle": {
    "fontFamily": "string",
    "fontSize": 1.1,
    "fontWeight": 1.1,
    "textColor": "string",
    "textAlpha": 1.1
  },
  "globalLayers": [
    {
      "layerId": "string",
      "totalAssets": 1,
      "assets": [
        {
          "assetId": "string",
          "type": "string",
          "timing": {
            "startSeconds": 1.1,
            "endSeconds": 1.1
          },
          "mediaType": "string",
          "volume": 1.1,
          "opacityPercent": 1.1,
          "position": {
            "xStartPct": 1.1,
            "xEndPct": 1.1,
            "yStartPct": 1.1,
            "yEndPct": 1.1,
            "rotationDeg": 1.1
          },
          "nextTextOffset": 1,
          "nextTtsTextOffset": 1,
          "text": "string",
          "ttsText": "string",
          "captionsAvailable": true,
          "transcript": {
            "source": "string",
            "trimApplied": false,
            "totalWords": 1,
            "words": [
              {
                "chunkIndex": 1,
                "wordIndex": 1,
                "text": "string",
                "nextTextOffset": 1,
                "sourceStartSeconds": 1.1,
                "sourceEndSeconds": 1.1,
                "captionsVisible": true
              }
            ]
          },
          "captionChunks": {
            "total": 1,
            "visible": 1
          },
          "ttsEnabled": true,
          "fileId": "string",
          "playback": {
            "type": "CONTROLLED",
            "rate": 1.1
          },
          "trim": {
            "startSeconds": 1.1,
            "endSeconds": 1.1
          },
          "fit": {
            "type": "string",
            "crop": {
              "xStartPct": 1.1,
              "xEndPct": 1.1,
              "yStartPct": 1.1,
              "yEndPct": 1.1
            }
          },
          "appearance": {
            "locked": true,
            "border": {
              "width": 1.1,
              "color": "string"
            },
            "radii": {
              "topLeftPercent": 1.1,
              "topRightPercent": 1.1,
              "bottomLeftPercent": 1.1,
              "bottomRightPercent": 1.1
            },
            "filters": [
              {
                "type": "string",
                "amount": 1.1
              }
            ],
            "textStyle": {
              "fontFamily": "string",
              "fontSize": 1.1,
              "fontWeight": 1.1,
              "textColor": "string",
              "textAlpha": 1.1
            },
            "hasMixedTextStyles": true,
            "shapeFill": {
              "color": "string",
              "alpha": 1.1
            },
            "svgColors": {},
            "svgColorsTruncated": true,
            "filtersTruncated": true,
            "enterAudioFadeSeconds": 1.1,
            "exitAudioFadeSeconds": 1.1
          }
        }
      ]
    }
  ],
  "totalGlobalLayers": 1,
  "nextGlobalLayersOffset": 1,
  "pageKind": "SECTIONS",
  "totalItems": 1,
  "offset": 1,
  "textOffset": 1,
  "totalSections": 1,
  "nextOffset": 1,
  "evidence": {
    "composedFrames": "string",
    "audio": "string",
    "source": "string"
  },
  "sections": [
    {
      "sectionId": "string",
      "totalLayers": 1,
      "nextNameTextOffset": 1,
      "nextDescriptionTextOffset": 1,
      "name": "string",
      "description": "string",
      "outline": {
        "type": "TEXT_TO_SPEECH",
        "summary": "string",
        "nextSummaryTextOffset": 1,
        "voiceoverText": "string",
        "nextVoiceoverTextOffset": 1,
        "direction": "string",
        "nextDirectionTextOffset": 1,
        "speechVolume": 1.1,
        "voiceSpeed": 1.1,
        "sourceFileId": "string",
        "sourceTrim": {
          "startSeconds": 1.1,
          "endSeconds": 1.1
        },
        "application": "string"
      },
      "timing": {
        "startSeconds": 1.1,
        "endSeconds": 1.1
      },
      "layers": [
        {
          "layerId": "string",
          "totalAssets": 1,
          "assets": [
            {
              "assetId": "string",
              "type": "string",
              "timing": {
                "startSeconds": 1.1,
                "endSeconds": 1.1
              },
              "mediaType": "string",
              "volume": 1.1,
              "opacityPercent": 1.1,
              "position": {
                "xStartPct": 1.1,
                "xEndPct": 1.1,
                "yStartPct": 1.1,
                "yEndPct": 1.1,
                "rotationDeg": 1.1
              },
              "nextTextOffset": 1,
              "nextTtsTextOffset": 1,
              "text": "string",
              "ttsText": "string",
              "captionsAvailable": true,
              "transcript": {
                "source": "string",
                "trimApplied": false,
                "totalWords": 1,
                "words": [
                  {
                    "chunkIndex": 1,
                    "wordIndex": 1,
                    "text": "string",
                    "nextTextOffset": 1,
                    "sourceStartSeconds": 1.1,
                    "sourceEndSeconds": 1.1,
                    "captionsVisible": true
                  }
                ]
              },
              "captionChunks": {
                "total": 1,
                "visible": 1
              },
              "ttsEnabled": true,
              "fileId": "string",
              "playback": {
                "type": "CONTROLLED",
                "rate": 1.1
              },
              "trim": {
                "startSeconds": 1.1,
                "endSeconds": 1.1
              },
              "fit": {
                "type": "string",
                "crop": {
                  "xStartPct": 1.1,
                  "xEndPct": 1.1,
                  "yStartPct": 1.1,
                  "yEndPct": 1.1
                }
              },
              "appearance": {
                "locked": true,
                "border": {
                  "width": 1.1,
                  "color": "string"
                },
                "radii": {
                  "topLeftPercent": 1.1,
                  "topRightPercent": 1.1,
                  "bottomLeftPercent": 1.1,
                  "bottomRightPercent": 1.1
                },
                "filters": [
                  {
                    "type": "string",
                    "amount": 1.1
                  }
                ],
                "textStyle": {
                  "fontFamily": "string",
                  "fontSize": 1.1,
                  "fontWeight": 1.1,
                  "textColor": "string",
                  "textAlpha": 1.1
                },
                "hasMixedTextStyles": true,
                "shapeFill": {
                  "color": "string",
                  "alpha": 1.1
                },
                "svgColors": {},
                "svgColorsTruncated": true,
                "filtersTruncated": true,
                "enterAudioFadeSeconds": 1.1,
                "exitAudioFadeSeconds": 1.1
              }
            }
          ]
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.videogen.io/v1/projects/projectId/videos/editableVideoId/inspection"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```