Personas

Get a persona photo

Returns one persona photo. Poll it every 5 seconds while status is processing; image_url is set once ready.

get/personas/{id}/shots/{shotId}

Request

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

Path parameters

idstring required
shotIdstring required

Response

Response for status 200

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

The persona version whose photo the shot was drawn from.

scenestring required

The scene the user wrote; empty when a template was used.

template'mirror' | 'kitchen' | 'bathroom' | 'sofa' | 'cafe' | 'gym' | 'street' | 'closeup' | 'story' | 'bedroom' nullable 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.

aspect_ratio'9:16' | '4:5' | '1:1' | '16:9' required
credits_chargednumber required

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

image_urlstring nullable required

Signed URL of the JPEG, valid for one hour. Set once ready.

expected_secondsnumber nullable required

Typical seconds from created_at until a photo is ready. 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.

created_atstring required

Changes

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