Sign in

v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB
Video Projects

Character Replace

What this API does

Create the same Character Replace you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.

Good for

  • Automation and batch processing
  • Adding character replace into apps, pipelines, or tools

How it works (3 steps)

  1. Upload your inputs (video, image, or audio) with Generate Upload URLs and copy the file_path.
  2. Send a request to create a character replace job with the basic fields.
  3. Check the job status until it's complete, then download the result from downloads.

Key options

  • Inputs: usually a file, sometimes a YouTube link, depending on project type
  • Resolution: free users are limited to 576px; higher plans unlock HD and larger sizes
  • Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt

Cost
Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done.

For detailed examples, see the product page.

post/v1/character-replace

Request body

namestring

Give your video a custom name for easy identification.

start_secondsnumber float

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

end_secondsnumber float required

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

resolution'480p' | '720p'

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

Example request

{
  "name": "My Character Replace video",
  "end_seconds": 15,
  "resolution": "720p",
  "assets": {
    "video_file_path": "api-assets/id/1234.mp4",
    "image_file_path": "api-assets/id/5678.png"
  },
  "style": {
    "mode": "replace",
    "selection_mode": "auto"
  }
}

Response

Success

idstring required

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

credits_chargedinteger 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 response

{
  "id": "cuid-example",
  "credits_charged": 450
}