relight_image
Change the lighting of an image (a VerseIn media URL) with a lighting preset or a text description. Spends the user's coins; calls above the confirmation threshold return needs_confirmation with a confirmation_token; ask the user, then call again with it. Returns a task id; follow it with get_tasks. Generating through an AI assistant is charged in VerseIn coins. Unlimited-plan allowances do not apply here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | style (a lighting preset) or text (describe the lighting in prompt). Default: text when prompt is set, else style | |
| speed | No | quality tier; slower tiers cost more | |
| preset | No | lighting preset key (style mode); an invalid key is answered with the valid ones | |
| prompt | No | the lighting to apply (text mode) | |
| image_url | Yes | the image to relight — a VerseIn media URL | |
| intensity | No | effect strength, 0 to 100 | |
| request_id | No | your id for this call; retrying with the same id never charges twice. Use a new id to intentionally repeat identical settings | |
| max_total_coins | No | the most this edit may charge: send the exact most the user agreed to (the max_coins of estimate_cost, or total_cost_coins when equal). If the job could now cost more, nothing is submitted and needs_confirmation returns the new price | |
| confirmation_token | No | the confirmation_token a needs_confirmation answer returned, passed back once the user agreed to that price |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | present only when the call failed | |
| tasks | No | ||
| failed | No | ||
| balance | No | balance after submitting | |
| declined | No | true when the user declined the confirmation form; nothing was submitted or charged | |
| next_action | No | ||
| total_cost_coins | Yes |