Personas

Get a persona

Returns the persona with its photo. Poll it every 5 seconds while image_status is generating.

get/personas/{id}

Request

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

Path parameters

idstring required

Response

Response for status 200

idstring required
namestring required

Empty until the persona is saved.

status'draft' | 'ready' required
uses_face_photosboolean required

true when the persona was made from reference photos: the face, skin, eyes and hair come from them.

preset_idstring nullable required

The ready-made character this persona started from. Such a persona stays that character: chips are ignored on regenerate, a note still edits it.

image_status'generating' | 'ready' | 'failed' required
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.

image_urlstring nullable required

Signed URL of the persona photo (close-up and full body side by side). Valid for one hour.

Changes

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