Personas

Get a persona video

Returns one persona video. Poll it every 10 seconds while status is processing; download_url is set once ready.

get/personas/{id}/videos/{videoId}

Request

  • Base URL: https://api.cut.pro/api/v1
  • URL: https://api.cut.pro/api/v1/personas/{id}/videos/{videoId}
  • Auth: API key in header X-Api-Key

Path parameters

idstring required
videoIdstring required

Response

Response for status 200

idstring required
type'swap' | 'product' | 'motion' | 'control' required

What kind of video this is. swap replaces the person in a library video with the persona; product is a product ad the persona talks in, made on the web app.

quality'economy' | 'standard' | 'high' required

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.

replace'head' | 'person' | 'none' required

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.

style'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' nullable required

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.

status'processing' | 'ready' | 'failed' required
version_idstring nullable required

The persona version (from the persona's versions) whose photo the video was made from.

duration_secondsnumber required

Measured duration of the source video, which is what was priced.

credits_chargednumber required

Credits debited for this video. Refunded automatically when it fails.

edit_idstring nullable required

Edit created from the result, ready for POST /renders and POST /posts. Set once ready.

download_urlstring nullable required

Signed URL of the resulting MP4, valid for six hours. Set once ready; once handed out, the video counts as downloaded and its credits can no longer be asked back.

thumbnail_urlstring nullable required

Signed URL of the cover image, valid for six hours.

expected_secondsnumber nullable required

Expected seconds from created_at until the video is ready, refined as the job advances. Only while processing.

error_code'MEDIA_REJECTED' | 'COPYRIGHT_BLOCKED' | 'REAL_FACES_BLOCKED' | 'SAFETY_BLOCKED' | 'MEDIA_FAILED' | 'MEDIA_UNAVAILABLE' | 'INSUFFICIENT_CREDITS' | 'TIMEOUT' | 'OUTPUT_CHECK_FAILED' nullable required

Why the last generation failed, null otherwise: COPYRIGHT_BLOCKED (the scene looks like copyrighted material), REAL_FACES_BLOCKED (a real face is too prominent), SAFETY_BLOCKED (the provider's content rules) and MEDIA_REJECTED (refused for another reason); for any refusal change the traits, the photos or the video. MEDIA_FAILED and MEDIA_UNAVAILABLE (generation broke, retry), INSUFFICIENT_CREDITS, TIMEOUT, OUTPUT_CHECK_FAILED (the video did not keep the persona on the right person even after one free redo; try another video or pick the person). Credits of a failed generation are refunded automatically.

feedback'up' | 'down' nullable required

up liked, down disliked, null not rated.

feedback_reasonstring nullable required

Set with a down vote; one of the video feedback reasons.

created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.