Cut.ProDocs
AI characters

Get a persona video

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

Authorization

apiKey
X-Api-Key<token>

In: header

Path Parameters

id*string
videoId*string

Response Body

application/json

application/json

GET
/personas/{id}/videos/{videoId}
curl -X GET "https://example.com/personas/string/videos/string"
{  "id": "string",  "type": "swap",  "quality": "economy",  "replace": "head",  "style": "cel",  "status": "processing",  "version_id": "string",  "duration_seconds": 0,  "credits_charged": 0,  "edit_id": "string",  "download_url": "string",  "thumbnail_url": "string",  "expected_seconds": 0,  "error_code": "MEDIA_REJECTED",  "feedback": "up",  "feedback_reason": "string",  "created_at": "string"}

Create a persona video POST

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.

Read a product from its page link POST

Free. Reads a product page (most online stores, Shopee and Amazon Brazil) and returns its name, description, price and brand, and keeps up to 3 of its photos, whose ids go in `product.photo_ids` of `POST /personas/{id}/shots`. `partial` is `true` when the price or the photos did not come. `PRODUCT_NOT_READABLE` means the page could not be read (Mercado Livre and TikTok Shop never are): upload the photos with `POST /personas/{id}/shots/photos` and write the fields yourself. Up to 5 reads per minute.