Run a preset
run_presetStarts a preset on the user's photo and reserves its credits; they are refunded in full if the job fails or is blocked. The photo must be the user's own upload (create_upload or import_image). If people are shown in it, ask the user first whether everyone shown agreed to appear in the clip; pass consent true only then (it is always required). Pass max_credits (the credits from list_presets or ask_director) so the job only starts at the price you showed. idempotency_key is required: a new unique string per intended run, the same one only to retry it. Pass wait_seconds or poll get_job; clips take minutes.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"preset_id": "<preset_id>",
"image": "<image>",
"consent": "<consent>",
"idempotency_key": "<idempotency_key>"
},
"name": "run_preset"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wish | No | A short extra wish in the user's words, e.g. «with a red cape». Required for a preset with line: the exact words spoken in the clip (up to 120 characters). | |
| image | Yes | The user's photo: the path from create_upload or import_image (/api/media/uploads/…). | |
| consent | Yes | true only if the user confirmed that everyone shown in the photo agreed to appear in the clip (or nobody is shown). | |
| preset_id | Yes | From list_presets or a preset proposal of ask_director. | |
| max_credits | No | The credits from list_presets. The job does not start if it now costs more. | |
| wait_seconds | No | Seconds to wait for the job to finish (0 to 50). | |
| idempotency_key | Yes | A new unique string per intended run, e.g. a UUID. Reuse it only to retry that run. |