GET
/v1/schemas/meta/image/v1/images/edits
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. docs-derived Source trace361efdc7d4626de2d7a581a60cd6509326bf3fcc305d2db4bd9ac0a9b13005d0{
"fetchedAt": 1794201665,
"extractorVersion": "2",
"verifiedAt": null
} |
Request body
11 properties · 2 required · 1 $defs| property | type | description | constraints |
|---|---|---|---|
| prompt* | string | Text description of the edits to apply. | |
| model* | string | Model ID. | |
| image | string | Image to edit. PNG format. | format: binary |
| n | integer | Number of edited images to generate. Range: 1-10. Defaults to 1. (minimum: 1, maximum: 10, default: 1) | 1 ≤ n ≤ 10 · default: 1 |
| size | string | Requested image shape as width x height (e.g., '1024x1024'). The values set the aspect ratio; the image is produced at the generator's own resolution, so the returned pixel dimensions will not necessarily match the numbers supplied. | |
| response_format | enum | Format for the edited images. One of url or b64_json. Default: b64_json. (default: b64_json) | url | b64_json |
| reasoning_strength | enum | How much reasoning the image generator applies before producing the edited image. One of low or high. low returns after a single generation pass (no self-refinement); high (the default) lets the generator iteratively refine. (default: high) | low | high |
| moderation | string | Moderation level for the safety pipeline. One of auto or low. Enabled per model: on models where it is not enabled, any moderation value returns 400 (code: unsupported_parameter, param: moderation); omitting moderation is always valid. On enabled models, unkno… | |
| stream | boolean | If true, streams the response as server-sent events. Defaults to false. (default: false) | default: false |
| partial_images | integer | Number of partial images to generate during streaming. Range: 0-3. Accepted but ignored. (minimum: 0, maximum: 3, default: 0) | 0 ≤ n ≤ 3 · default: 0 |
| tool_enablement | image-tool-enablement | Per-tool controls for the image generator's planner. Omit to keep the default (all tools available). |
Types
1 $defsimage-tool-enablementobject
| enable_image_search | boolean | Whether the image generator may search the web for visual references. false disables it. | |
| enable_web_search | boolean | Whether the image generator may search the web for facts. false disables it (also drops the browser tools). | |
| enable_shell | boolean | Whether the image generator may run code to build layouts and charts. false disables it. |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"meta","endpointId":"v1/images/edits","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}