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
firstFrame
string<uri>
required

Public HTTPS URL of the source video's extracted first-frame image. This image supplies the pose, framing, lighting, background, and composition to preserve. http:// URLs are rejected.

characterId
string
required

Id of a previously created character (from createCharacter or GET /v1/characters) whose stored image supplies the replacement identity.

prompt
string
required

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

Minimum string length: 1

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.