Skip to Content
Cut.ProDocs
AI characters

Create a persona video

Starts a video with a saved persona. type picks the kind of video; today the only one is swap, which keeps the scene, camera, motion and sound of a library video and replaces its main person with the persona. quality (default standard) and replace (default person) pick how; style (none by default) redraws it in a drawing technique; quote and create with the same quality and style. version_id picks which of the persona's versions to use, the current one when left out. Charged per second of the source, scenes of the person included, even on a workspace with unlimited usage, and refunded automatically if it fails. Picking a target never raises the price above the quote.

Price it first with GET /personas/swap/quote and send that credits: when the server measures a different price it refuses with 409 PRICE_CHANGED and the right one in extra, so nothing is ever charged above what was confirmed.

Responds 202. Poll GET /personas/{id}/videos/{videoId} every 10 seconds until ready or failed; the result also lands in the library, and POST /generations/{id}/edit with the video's id gives the edit_id for POST /renders and POST /posts. VIDEO_IN_PROGRESS means this persona is already working on the same version with the same video.

Authorization

apiKey
headerX-Api-Key<token>

Path Parameters

id*string

Request Body

  1. body
type*"swap"

The kind of video to make; only swap is made here.

Value in"swap"
media_id*string

Library video whose person is replaced.

credits*|

The price returned by GET /personas/swap/quote for this media_id and quality.

Range0 <= value
quality?string

economy is standard at a lower resolution, upscaled to 1080p, and the cheapest. standard follows the persona's traits, up to video_limits.standard.max_seconds. high also follows the persona's photos, keeps the face closest to them and takes longer videos, at a higher price; prefer it for personas made from face photos.

Value in"economy""standard""high"
replace?string

What of the video's main person becomes the persona: head changes only the head and hair and keeps the body and outfit, person replaces the whole person, body and outfit included, none replaces nobody and only applies the style, which then is required.

Value in"head""person""none"
style?string

Redraws the whole video, people and scene, in an animation, illustration, material or camera look while keeping its camera and motion, for example cel (hand-painted 2D animation), felt (felt puppet stop motion), toy (rounded toy 3D), pixel (pixel art), stainedglass (stained glass) or silent (1920s silent film). The whole person is replaced, whatever replace says, unless it is none. Not available at quality: high past video_mid_max_seconds.

Value in"cel""felt""yarn""sketch""toy""grotesque""painterly""graphic""gouache""sculptural""lowpoly""toon""cinematic""flat""neon""editorial""comic""pixel""plush""embroidery""mosaic""stainedglass""chalk""silent""thermal""hologram"
version_id?string

A persona version id from versions. Defaults to the current version.

target?|

Picks who becomes the persona: a person seen in the video, or whoever is filming. Defaults to the main person. Refused with TARGET_UNSUPPORTED past the end of the video or on high-quality sources longer than video_mid_max_seconds; when nobody is at that spot the video fails with TARGET_NOT_A_PERSON and is refunded.

Response Body

Response for status 202

application/json
  1. response
id*string

Persona video id.

status*"processing"
Value in"processing"
credits_charged*number

Credits debited now. Refunded automatically if the video fails.

POST
/personas/{id}/videos
Example Request
curl -X POST 'https://api.cut.pro/api/v1/personas/string/videos' \  -H 'Content-Type: application/json' \  -d '{  "type": "swap",  "media_id": "string",  "credits": 0}'
Example Response
{  "id": "string",  "status": "processing",  "credits_charged": 0}