Skip to main content
POST
Character Replace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

end_seconds
number<float>
required

End time of your clip (seconds). Must be greater than start_seconds.

Required range: x >= 0.1
Example:

15

assets
object
required

Source video and reference character image for the job.

name
string
default:Character Replace - dateTime

Give your video a custom name for easy identification.

Example:

"My Character Replace video"

start_seconds
number<float>
default:0

Start time of your clip (seconds). Must be ≥ 0.

Required range: x >= 0
Example:

0

resolution
enum<string>

Output video resolution. Defaults to 480p, the lowest resolution available on your plan.

Available options:
480p,
720p
Example:

"720p"

style
object

Optional style controls for replace vs animate mode and subject selection.

Response

Success

Success

id
string
required

Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.

Example:

"cuid-example"

credits_charged
integer
required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

Example:

450