CreateImageRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aihubmix/main/json-schema/aihubmix-create-image-request-schema.json",
  "title": "CreateImageRequest",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": {
    "from": "avs://openai/official",
    "authority": "official"
  },
  "type": "object",
  "properties": {
    "prompt": {
      "description": "A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.",
      "type": "string",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "enum": [
            "gpt-image-1.5",
            "dall-e-2",
            "dall-e-3",
            "gpt-image-1",
            "gpt-image-1-mini"
          ]
        }
      ],
      "default": "dall-e-2",
      "nullable": true,
      "description": "The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to `dall-e-2` unless a parameter specific to the GPT image models is used.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "n": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "maximum": 10,
      "default": 1,
      "description": "The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "quality": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "standard",
        "hd",
        "low",
        "medium",
        "high",
        "auto"
      ],
      "default": "auto",
      "description": "The quality of the image that will be generated.\n\n- `auto` (default value) will automatically select the best quality for the given model.\n- `high`, `medium` and `low` are supported for the GPT image models.\n- `hd` and `standard` are supported for `dall-e-3`.\n- `standard` is the only option for `dall-e-2`.\n",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "response_format": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "url",
        "b64_json"
      ],
      "default": "url",
      "description": "The format in which generated images with `dall-e-2` and `dall-e-3` are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "output_format": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "png",
        "jpeg",
        "webp"
      ],
      "default": "png",
      "description": "The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "output_compression": {
      "type": [
        "integer",
        "null"
      ],
      "default": 100,
      "description": "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.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "stream": {
      "type": [
        "boolean",
        "null"
      ],
      "default": false,
      "description": "Generate the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information.\nThis parameter is only supported for the GPT image models.\n",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "partial_images": {
      "$ref": "#/$defs/PartialImages",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "size": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "enum": [
            "auto",
            "1024x1024",
            "1536x1024",
            "1024x1536",
            "256x256",
            "512x512",
            "1792x1024",
            "1024x1792"
          ]
        }
      ],
      "default": "auto",
      "nullable": true,
      "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "moderation": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "low",
        "auto"
      ],
      "default": "auto",
      "description": "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).",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "background": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "transparent",
        "opaque",
        "auto"
      ],
      "default": "auto",
      "description": "Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for the GPT image models. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.\n",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "style": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "vivid",
        "natural"
      ],
      "default": "vivid",
      "description": "The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    },
    "user": {
      "type": "string",
      "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#end-user-ids).\n",
      "x-providers-default": "drop",
      "x-providers": {
        "openai": {},
        "azure": {}
      }
    }
  },
  "required": [
    "prompt"
  ],
  "$defs": {
    "PartialImages": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 3,
          "minimum": 0,
          "default": 0,
          "description": "The number of partial images to generate. This parameter is used for\nstreaming responses that return partial images. Value must be between 0 and 3.\nWhen set to 0, the response will be a single image sent in one streaming event.\n\nNote that the final image may be sent before the full number of partial images\nare generated if the full image is generated more quickly.\n"
        },
        {
          "type": "null"
        }
      ],
      "x-source": {
        "from": "avs://openai/official",
        "authority": "official"
      }
    }
  }
}