Remove Image Background
remove_image_backgroundRemove the background from a completed mascot, mascot pose, or standalone composition so it can sit cleanly inside UI layouts.
Use before embedding generated assets on cards, dashboards, modals, colored sections, transparent overlays, empty states, success/error pages, or app surfaces where a rectangular background would look unpolished.
Do not use before the source generation has a completed imageUrl. Do not use when the rectangular/full-bleed background is intentional, such as a hero illustration that fills its whole frame.
Background removal is asynchronous. This tool returns imageUrl and assetUrl immediately; they serve a frontend placeholder while pending and redirect to the transparent image when ready. Poll get_generation_status until completed before downloading the final image.
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": {
"canvasId": "<canvasId>"
},
"name": "remove_image_background"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| canvasId | Yes | Canvas id for the completed mascot, mascot pose, or composition. Use canvasId returned by the creation tool or get_generated_asset. | |
| workspace | No | Optional workspace id or slug from list_workspaces. Defaults to the user's personal workspace. Use the same workspace for every call in a workflow, because generations, mascots, and palettes belong to one workspace. | |
| revisionId | No | Optional revision id to remove the background from. Omit to use the current completed revision. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Current async state. If pending, poll get_generation_status. If completed, call get_generated_asset. | |
| assetUrl | No | Embeddable asset URL for the generation, matching imageUrl for images and videoUrl for animations. It can be used immediately while polling continues. | |
| canvasId | No | Underlying SVG App canvas id when the generation produced an image. Kept for UI integration and background removal. | |
| imageUrl | No | Embeddable image URL. It is returned immediately, serves a frontend placeholder while pending, and redirects to the final image when ready. | |
| mimeType | No | MIME type of the final asset when known, for example image/png or video/mp4. | |
| videoUrl | No | Embeddable video URL for animation generations. It is returned immediately, serves a frontend placeholder video while pending, and redirects to the final transparent WebM video when ready. | |
| nextAction | Yes | The exact next MCP action the model/client should take for this generation. | |
| animationId | No | Underlying SVG App video generation id when the generation produced an animation. | |
| resourceUri | No | Optional MCP resource URI for clients that explicitly choose to read resources. Do not rely on resources for polling. | |
| generationId | Yes | Pass this exact id to get_generation_status until status is completed. The returned asset URL can be used immediately. |