> ## Documentation Index > Fetch the complete documentation index at: https://docs.gmicloud.ai/llms.txt > Use this file to discover all available pages before exploring further. # gpt-image-2-edit > API usage guide for gpt-image-2-edit. {/* source_model_id: gpt-image-2-edit */} {/* source_updated_at: 1781739052 */} **Model ID** ```bash theme={null} gpt-image-2-edit ``` **Calling method:** sync # gpt-image-2-edit API Usage Guide ## Overview **gpt-image-2-edit** uses OpenAI's GPT Image 2 model to edit or transform an existing image based on a text prompt. It supports two modes: * **Image Edit**: Modify an image according to a prompt (e.g. change background, style transfer) * **Inpainting**: Edit a specific region of an image using a mask (white pixels are edited, black pixels are preserved) ## Authentication ```bash theme={null} Authorization: Bearer YOUR_API_KEY ``` ## Submit Image Edit Request ### Endpoint ``` POST /api/v1/ie/requestqueue/apikey/requests ``` ### Image Edit (no mask) ```bash theme={null} curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-image-2-edit", "payload": { "prompt": "Replace the background with a snowy mountain scene", "image": "", "size": "1024x1024", "quality": "medium" } }' ``` ### Inpainting (with mask) ```bash theme={null} curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-image-2-edit", "payload": { "prompt": "Paint a rainbow in the sky", "image": "", "mask": "", "size": "1024x1024", "quality": "medium" } }' ``` ### Request Parameters | Parameter | Type | Required | Description | Default | Constraints | | ----------------- | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------- | | `model` | string | Yes | Model identifier | - | Must be `"gpt-image-2-edit"` | | `payload.prompt` | string | Yes | Text instruction describing the desired edit | - | - | | `payload.image` | string | Yes | Input image as base64-encoded string or publicly accessible URL | - | Must be a valid image | | `payload.mask` | string | No | Mask image for inpainting. White pixels are edited, black pixels are preserved. Must match the dimensions of `image`. | - | Same size as input image | | `payload.size` | string (enum) | No | Dimensions of the output image | `"1024x1024"` | `"1024x1024"`, `"1024x1536"`, `"1536x1024"` | | `payload.quality` | string (enum) | No | Image quality level — affects detail and cost | `"medium"` | `"low"`, `"medium"`, `"high"`, `"auto"` | | `payload.n` | integer | No | Number of images to generate | `1` | Min: 1, Max: 10 | ### Response ```json theme={null} { "request_id": "cd5b59d5-1b3f-4fd5-9899-15ecea1f28ba", "model": "gpt-image-2-edit", "status": "success", "outcome": { "media_urls": [{"id": "0", "url": "https://storage.googleapis.com/..."}], "thumbnail_image_url": "https://storage.googleapis.com/..." } } ``` ## Pricing Billing is based on the **actual token consumption** reported by OpenAI for each request. Users are charged according to the real usage of input text tokens, cached input text tokens, input image tokens, cached input image tokens, and output image tokens. The final cost may vary depending on prompt length, whether input images are provided, image size, quality, number of generated images, and other request parameters. ### Token Pricing Prices below are charged **per 1M tokens**: | Token Type | Price | | ------------------------- | ------------------- | | Text input tokens | \$5.00 / 1M tokens | | Cached text input tokens | \$1.25 / 1M tokens | | Image input tokens | \$8.00 / 1M tokens | | Cached image input tokens | \$2.00 / 1M tokens | | Image output tokens | \$30.00 / 1M tokens | ### Billing Formula ```text theme={null} Total cost = (text_input_tokens × $5.00 / 1,000,000) + (cached_text_input_tokens × $1.25 / 1,000,000) + (image_input_tokens × $8.00 / 1,000,000) + (cached_image_input_tokens × $2.00 / 1,000,000) + (image_output_tokens × $30.00 / 1,000,000) ``` ### Estimated Price Reference (per image) The following table is provided as a **reference only** for common quality and resolution combinations. These are estimated per-image prices and may differ from the final billed amount, which is always based on actual token usage. | Quality | 1024x1024 | 1024x1536 | 1536x1024 | | ------- | --------- | --------- | --------- | | Low | \$0.006 | \$0.005 | \$0.005 | | Medium | \$0.053 | \$0.041 | \$0.041 | | High | \$0.211 | \$0.165 | \$0.165 | ## Check Request Status ``` GET /api/v1/ie/requestqueue/apikey/requests/{request_id} ``` ## Native OpenAI Format (Raw API) Use the native OpenAI-compatible endpoint for direct integration with the OpenAI SDK or clients. ### Base URL ``` https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/v1 ``` ### Edit Image (multipart) ```bash theme={null} curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/v1/images/edits" \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "model=gpt-image-2" \ -F "prompt=Replace the background with mountains" \ -F "image=@photo.jpg" \ -F "size=1024x1024" \ -F "quality=medium" ``` ### Edit Image (JSON + base64) ```bash theme={null} curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/v1/images/edits" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-image-2", "prompt": "Replace the background with mountains", "image": "data:image/jpeg;base64,...", "size": "1024x1024", "quality": "medium" }' ``` ### Native Parameters | Parameter | Type | Required | Description | Default | Notes | | -------------------- | ------------- | -------- | ----------------------------------------------------------------- | ------------- | -------------------------------------------------------- | | `model` | string | **Yes** | Must be `"gpt-image-2"` | - | No other value accepted | | `prompt` | string | **Yes** | Text instruction for the edit | - | - | | `image` | file / string | **Yes** | Input image — binary file (multipart) or base64 data URI (JSON) | - | Up to 16 images via `image[]` | | `mask` | file / string | No | Inpainting mask — white pixels are edited, black pixels preserved | - | Same dimensions as input image | | `size` | string | No | `WxH` format | `"1024x1024"` | Both dimensions must be multiples of 16; max edge 3840px | | `quality` | string | No | `low` / `medium` / `high` / `auto` | `"medium"` | - | | `n` | integer | No | Number of images (1–10) | `1` | Each image billed separately | | `output_format` | string | No | `png` / `jpeg` | `"png"` | - | | `output_compression` | integer | No | Compression level 0–100 | null | Only valid for `jpeg` | ### Native Response Format ```json theme={null} { "created": 1780943967, "size": "1024x1024", "quality": "medium", "output_format": "png", "data": [ { "b64_json": "" } ], "usage": { "input_tokens": 592, "input_tokens_details": { "text_tokens": 16, "image_tokens": 576 }, "output_tokens": 256, "output_tokens_details": { "image_tokens": 256, "text_tokens": 0 }, "total_tokens": 848 } } ``` ### OpenAI SDK Usage ```python theme={null} from openai import OpenAI client = OpenAI( api_key="YOUR_API_KEY", base_url="https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests/v1" ) with open("photo.jpg", "rb") as f: response = client.images.edit( model="gpt-image-2", image=f, prompt="Replace the background with mountains", size="1024x1024", quality="medium" ) print(response.data[0].b64_json) ```