Image Edit
AI-generatedSummary
Edit an existing image by submitting an image URL and an optional mask to Seedream's AI model, guided by a text prompt and optional negative prompt, to generate edited images with defined aspect ratios and seed control.
Inputs
- Model (required) — Choose the Seedream image editing model to use, either 'Seedream 4.5 Edit (Recommended)' or 'Seedream 4.0 Edit'.
- Prompt (required) — Provide a text prompt describing the desired edits to apply to the image.
- Image URL (required) — URL of the original image to be edited.
- Mask URL — Optional URL of a mask image to specify areas targeted for editing.
- Aspect Ratio — Select the output image's aspect ratio such as Square, Landscape, or Portrait formats.
- Negative Prompt — List elements or features to avoid including in the edited output image.
- Seed — Set a seed number for randomization control; use 0 for random seed on each run.
- Reply URL — Webhook URL to be called asynchronously when the image edit task completes.
- Reply Ref — Custom reference string that will be passed back in the webhook callback.
- Wait for Completion — Choose whether to wait synchronously for the edit task to complete before continuing workflow execution.
Output shape
a single JSON object containing task creation and completion information
The output includes the created task's details and, if 'Wait for Completion' is true, polls the task status until finished (success or fail) or times out after 5 minutes. The response contains the edited image URLs and metadata in a nested 'resultJson' field that is parsed for direct access.