GET
/v1/schemas/vercel/image/images/generations
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. generated Source trace898eefefea6b5dc52da42f5628a64a0ffba65d850282e1cb59ab459f7e356f92{
"fetchedAt": 1793856100,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
19 properties · 1 required · 6 $defs| property | type | description | constraints |
|---|---|---|---|
| prompt* | string | A text description of the desired image(s). The maximum length is 32000 characters. | |
| frame_count | frame_count | Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to 9 when omitted. Only supported with output_format=gif. The requested size must satisfy the selected model's GIF size limits. GIF output does not support streaming, partial images,… | 2 ≤ n ≤ 16 |
| frame_duration_ms | frame_duration_ms | Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted. GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms per frame. Only supported with output_format=gif. | n ≥ 20 |
| complexity | enum | Computation spent planning the image, independently of rendering quality. Uses the image model's configured default when omitted. For SVG output, controls the reference image, independently of the SVG author's reasoning. | low | medium | high | null |
| svg | svg | Selects the model and reasoning effort used to author SVG output. Requires output_format=svg and access to SVG model selection. When model selection is enabled, supply svg.model. When model selection is disabled, omit this object. The top-level model selects t… | |
| model | string | enum | The GPT image model to use for image generation. Specify a model explicitly. Supported models include `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-fl… | |
| n | any | The number of images to generate. Must be between 1 and 10. | 1 ≤ n ≤ 10 · default: 1 |
| quality | enum | The quality of the image that will be generated. - `auto` (default value) will automatically select the best quality for the given model. - `high`, `medium` and `low` are supported for the GPT image models. - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support `xhigh` and `max`. | low | medium | high | xhigh | max | auto · +2 more · nullable |
| response_format | enum | Legacy response format parameter for retired image models. Unsupported for GPT image models, which always return base64-encoded images. | url | b64_json | null · deprecated |
| output_format | enum | The format in which the generated images are returned. This parameter is only supported for the GPT image models. | png | jpeg | webp | gif | svg · nullable |
| output_compression | any | The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the `webp` or `jpeg` output formats, and defaults to 100. | default: 100 |
| stream | any | Generate the image in streaming mode. Defaults to `false`. See the [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information. This parameter is only supported for the GPT image models. | default: false |
| partial_images | integer | The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. | 0 ≤ n ≤ 3 · default: 0 · nullable |
| size | string | enum | The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as `WIDTHxHEIGHT` str… | |
| moderation | enum | Control the content-moderation level for images generated by the GPT image models. Must be either `low` for less restrictive filtering or `auto` (default value). | low | auto · nullable |
| background | enum | Allows to set transparency for the background of the generated image(s). Must be one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used, the model will automatically determine the best background for the image. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, support `opaque` and `transparent` backgrounds. Transparent backgrounds are available for supported GPT Image models. For `gpt-image-2` and `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`, set the output format to `png` or `webp`. | transparent | opaque | auto · nullable |
| style | enum | Legacy style parameter for retired image models. Unsupported for GPT image models; describe the desired style in the prompt instead. | vivid | natural | null · deprecated |
| safety_identifier | any | A stable identifier for an end user in your organization, used for safety monitoring and abuse detection. Hash a username or email address to avoid sending identifying information. A non-empty value takes precedence over the deprecated `user` parameter. If omi… | length ≤ 128 |
| user | string | Deprecated: use `safety_identifier` instead. This parameter remains accepted for backward compatibility and is used when `safety_identifier` is omitted, null, or empty. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-… | deprecated |
Types
6 $defscomplexityenum
Computation spent planning the image, independently of rendering quality. Uses the image model's configured default when omitted. For SVG output, controls the reference image, independently of the SVG author's reasoning.
low | medium | high | null
frame_countany
Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to 9 when omitted. Only supported with output_format=gif. The requested size must satisfy the selected model's GIF size limits. GIF output does not support streaming, partial images,…
2 ≤ n ≤ 16
frame_duration_msany
Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted. GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms per frame. Only supported with output_format=gif.
n ≥ 20
PartialImagesinteger
The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.
0 ≤ n ≤ 3 · default: 0 · nullable
ReasoningEffortEnumenum
none | minimal | low | medium | high | xhigh · +1 more
svgobject
Selects the model and reasoning effort used to author SVG output. Requires output_format=svg and access to SVG model selection. When model selection is enabled, supply svg.model. When model selection is disabled, omit this object. The top-level model selects t…
| model* | string | Model used to author the SVG. Required when SVG model selection is enabled. | length ≥ 1 |
| reasoning | object | Reasoning settings for the SVG author, independent of image complexity. Omitted or null effort uses the author model's default. Supported efforts depend on the selected author model. |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"vercel","endpointId":"images/generations","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}