Edit an existing generation with a plain-language instruction
edit_imageChanges a finished image from a plain-language instruction: add or remove something, or swap a face. Takes free text. Spends credits; returns a task id. Refuses real or famous people's likenesses.
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": {
"generationId": "<generationId>",
"kind": "<kind>",
"instruction": "<instruction>"
},
"name": "edit_image"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | "edit" for a general change, "remove" to delete something, "add" to insert a new person, "face" to face-swap an existing person's identity. Adding a non-person object (e.g. more goats) is "edit", not "add" — "add" is specifically for inserting a NEW PERSON. | |
| requestId | No | Optional. A unique id you choose for this job (a UUID is fine). If the call is repeated with the same requestId within 24 hours, the existing job comes back instead of a new render, so a retry is never charged twice. | |
| instruction | Yes | What to change, specifically. E.g. "add 4 more goats grazing in the middle distance, same breed as the one already in frame" or "remove the walking stick" or "change the sky to overcast". | |
| generationId | Yes | The generation_id from a completed generate_image or edit_image call — the photo to edit. | |
| referenceImageUrls | No | Optional reference photos (e.g. from list_reference_images) — an identity/appearance source for a "face" or "add" instruction. Must already be hosted on TASVR's own Supabase Storage. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| task_id | Yes |