Creative
Alphacreative_remove_background
Remove the background from a public image in the connected workspace when its Creative flag is enabled.
Operation Write.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | Yes | Media settings. |
body.image_url | string | Yes | Public HTTPS URL of a PNG, JPEG, or WebP image, up to 100 MB. |
body.sync_mode | boolean | No | Request inline PNG data from the provider. The result is still saved as a workspace artifact. |
body.mode | string | No | Use async to get a job ID immediately, sync or subscribe for a bounded wait, or webhook for terminal delivery. |
body.wait_timeout_seconds | integer | No | Wait from 0 to 30 seconds in sync or subscribe mode. |
body.webhook_url | string | No | Public HTTPS URL for terminal delivery. |
body.project_id | string | No | Destination project in the same workspace. |
body.metadata | object | No | Caller data to keep with the job. |
idempotency_key | string | Yes | Reuse this key to retry the same request. |
Use an uploaded image URL or a public HTTPS image. The job saves a transparent PNG.
Pass data.job.id to creative_jobs_wait, then read the saved output with creative_jobs_result.
Sample prompt
Remove the background from my uploaded product photo and give me the transparent PNG.