Image editing
Image tools operate on reachable source URLs. If your file is on your computer,
upload it as an asset and retrieve its processed
file_url first.
1. Prepare the source
Choose an image URL that the service can fetch without your browser session. For masked edits, prepare a reachable mask image as well. Replace all example URLs below with your own files.
2. Choose the operation
Run simplified image:outpaint --help, for example, for the full option set.
3. Run an edit
Remove a background and wait for the output:
Replace the background with a solid color:
Prepare a larger or differently encoded image:
Supported conversion formats are jpeg, jpg, png, webp, and bmp.
Upscaling supports factors of 2, 4, and 8.
4. Make a generative edit
For outpainting, both the source and mask are required:
Inspect the result before reusing it; generative edits can change details beyond the intended visual effect.
5. Retrieve and reuse the result
Most operations submit an asynchronous task. Without --wait, keep its
task_id and retrieve status with:
Waiting polls every two seconds for up to 120 seconds. Inspect the returned result for the output URL; response fields vary by operation. A timeout is a reason to check the existing task, not automatically submit a duplicate.
image:blur-background is synchronous and returns image_url directly:
Pass a successful output URL into another edit or attach it to a social draft.
