Studio

Compose a start frame for a scene (async job)

post/v1/studio/series/{seriesId}/episodes/{episodeId}/scenes/{sceneId}/compose-start-frame

Request

  • Base URL: https://api.lizzflix.xyz (the document declares no server; this is the origin it was published from)
  • URL: https://api.lizzflix.xyz/v1/studio/series/{seriesId}/episodes/{episodeId}/scenes/{sceneId}/compose-start-frame
  • Auth: none declared

Path parameters

seriesIdstring required
episodeIdstring required
sceneIdstring required

Request body

placementPromptstring required

Blocking and composition of the frame.

locationAssetIdstring

A plate of this series' location (the original form).

locationRefstring

Any of your images as the plate. One from another series, or a start frame, is copied into the scene's location (or locationId) when the frame is composed.

locationIdstring

The location a locationRef copy goes to; defaults to the scene's location.

characterAssetIdsstring[]

Images of this series' characters (the original form).

labelstring

Example request

{
  "locationRef": "asset:4b0f8c1e-2d5a-4c7e-9a1b-3f6d8e2c1a90",
  "characters": [
    {
      "ref": "asset:4b0f8c1e-2d5a-4c7e-9a1b-3f6d8e2c1a90"
    }
  ]
}

Response

Start frame job accepted

Changes

No recorded changes to this operation across all 1 revision of this API.