GET

/v1/schemas/fal/image/ideogram/v4.5/edit

Accept:

kind inputactivity imagehash e774b808…extracted Nov 10, 2026version currentsource upstream spec ↗

field	recorded source
schema	Source linked above. upstream-spec Source trace `ca9b72841e1316678b093001bc2269be0e474ebc5630d019d193a4d77ec75871` { "fetchedAt": 1794286801, "extractorVersion": "2", "verifiedAt": null }

Request body

13 properties · 2 required · 2 $defs

property	type	description	constraints
prompt*	string	The generation or editing prompt.	length ≥ 1 · length ≤ 10000
image_url*	string	Primary source image to edit.
reference_image_urls	string[]	Up to four references plus the primary source, or three references plus the primary source and mask.	items ≤ 4
num_images	integer	Number of images to generate.	1 ≤ n ≤ 8 · default: 1
image_size	ImageSize \| enum	auto preserves source geometry, downscaled by the provider if needed. Only unmasked regular edits accept named presets or custom sizes: dimensions >=256, multiples of 32, area <=4194304, ratio <=6:1. Named presets use standard fal dimensions.	default: "auto"
enable_safety_checker	boolean	Authorized callers may set false to request relaxed screening.	default: true
context_window	enum	Region to edit with high edit_precision. none edits the whole image, downscaled to at most 4194304 pixels. auto requires mask_url and fits the region around the mask; an oversized mask falls back to whole-image editing. Set context_window_box instead to pick t…	none \| auto · default: "none"
seed	integer	Random seed. Omit to choose automatically.	nullable
quality	enum	Quality tier for either edit precision. Defaults to medium.	very_low \| low \| medium \| high · default: "medium"
context_window_box	ContextWindowBox	Explicit region to edit with high edit_precision, in source pixels with exclusive x_max/y_max. Must lie inside the image, measure at least 256 pixels per side, cover at most 4194304 pixels, and have an aspect ratio within 1:6 and 6:1. A mask may select only pixels inside it. Cannot be combined with context_window auto. Leave unset to edit the whole image.	nullable
sync_mode	boolean	Return image data directly in the response.	default: false
mask_url	string	Mask matching the source dimensions. Black edits, white preserves. Must contain both regions after rounding.	nullable
edit_precision	enum	regular uses Generate; high uses Precise Edit with unchanged-pixel restoration. Both always prepare structured edit instructions.	regular \| high · default: "regular"

Types

2 $defs

ContextWindowBoxobject

x_min*	integer	Left edge in source pixels (inclusive).	n ≥ 0
y_max*	integer	Bottom edge in source pixels (exclusive).	n ≥ 0
y_min*	integer	Top edge in source pixels (inclusive).	n ≥ 0
x_max*	integer	Right edge in source pixels (exclusive).	n ≥ 0

ImageSizeobject

width	integer	The width of the generated image.	0 < n ≤ 14142 · default: 512
height	integer	The height of the generated image.	0 < n ≤ 14142 · default: 512

Validate a payload

before you spend tokens

shell

$ curl -X POST https://modelschemas.com/v1/validate \
    -d '{"provider":"fal","endpointId":"ideogram/v4.5/edit","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}