Skip to main content
GET

Overview

Answers the pictures and clips of a project in the order they play, as they are on its timeline now. Use it to change one moment of a video without making it again: find the scene, make a new image or clip for it, and swap it in with Edit Project in scenes, by index.
  • index counts from 0 in play order. Layers that overlap (a picture over a background clip) are listed one after the other.
  • startMs and endMs are milliseconds from the start of the video.
  • text is what the captions say while the scene is on screen, to tell which moment it is.
  • prompt is what the scene was generated from. Rework it and generate an image or a clip with the project’s aspectRatio; once it is COMPLETED, swap it in.
  • replaceable is false for a clip that plays its own sound (an avatar speaking, a character’s lines). Swapping it would drop that sound, so it is edited in the dashboard.

Changing one scene

  1. GET /v1/project/{projectId}/scenes and pick the scene by its text or time.
  2. Make the new media: Generate Image for an image scene, Generate Video for a clip scene (at least as long as the scene), or use one already in your library. Wait until it is COMPLETED.
  3. PATCH /v1/project/{projectId}/edit with { "scenes": [{ "index": 2, "mediaId": "..." }] }.
  4. Render Project for the new video. Only the new media costs credits; editing and rendering are free.

Errors

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
string
required

The projectId a create endpoint answered, or one from GET /v1/project/list.

Response

The project's scenes

success
boolean
message
string
data
object