Delete custom background
delete_backgroundPermanently delete one of the workspace's custom backgrounds, e.g. a scene the user no longer wants in their list. It cannot be undone through this server; a deleted scene has to be made again with create_background. Photos already generated with it are not affected, and no credits are charged or refunded. Only custom backgrounds (custom: true in list_backgrounds) can be deleted, never built-in ones. To change a scene instead of removing it, use refine_background. Returns the id with deleted: true, or not_found for an unknown id.
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": {
"background_id": "<background_id>"
},
"name": "delete_background"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| background_id | Yes | The `id` of a custom background. |