Skip to main content
POST
Create a character-swapped starting frame

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
prompt
string
required

Instructions for composing the starting frame (pose, framing, scene).

Minimum string length: 1
characterImageUrl
string<uri>

Public HTTPS URL of the character identity image. http:// URLs are rejected. Exactly one of characterImageUrl or characterId must be supplied.

characterId
string

Id of a previously created character (from createCharacter or GET /v1/characters) whose stored image should be used. Exactly one of characterImageUrl or characterId must be supplied.

sourceVideoUrl
string<uri>

Optional public HTTPS URL of the source video whose opening frame should ground the composition.

Response

The request has succeeded.

imageUrl
string<uri>
required

HTTPS CDN URL of the generated image.

model
string
required

Provider model id that produced the image.