# openai/gpt-image-2.6-sunburst/edit

> GPT Image 2.6 Sunburst Edit transforms one or more reference images using natural-language instructions, with a focus on precision, visual fidelity, and consistent detail across iterative edits for polished creative work, brand assets, product imagery, and production workflows. Ready-to-use REST inference API.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/openai/gpt-image-2.6-sunburst/edit`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `openai/gpt-image-2.6-sunburst/edit`
- **Category**: image-to-image

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
The API is asynchronous: submit a prediction, then poll its result URL until it completes.

### Input Schema

The API accepts the following input parameters:

- **`prompt`** (`string`, _required_):
  The positive prompt for the generation.

- **`images`** (`array of string`, _required_):
  List of URLs of input images for editing.

- **`mask_image`** (`string`, _optional_):
  Optional mask for the first input image: white marks the area to edit, black the area to keep (a PNG where transparent marks the area to edit is also accepted). It is resized to the first image.

- **`markup_image`** (`string`, _optional_):
  Optional transparent PNG of annotations (circles, arrows, notes) drawn over the first input image to show where and how to edit it. Use either mask_image or markup_image.

- **`aspect_ratio`** (`string`, _optional_):
  The aspect ratio of the generated image. If not specified, it is determined automatically from the input image.
  - Options: "1:1", "1:2", "2:1", "1:3", "3:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "9:16", "16:9", "9:21", "21:9"

- **`resolution`** (`string`, _optional_):
  The resolution of the output image.
  - Default: `"1k"`
  - Options: "1k", "2k", "4k"

- **`quality`** (`string`, _optional_):
  Rendering quality. Higher tiers add detail and cost more: low is the fastest draft tier, medium is the balanced default, high, xhigh and max add fidelity.
  - Default: `"medium"`
  - Options: "low", "medium", "high", "xhigh", "max"

- **`complexity`** (`string`, _optional_):
  How much planning the model does before drawing. Higher complexity improves layout and scene understanding on detailed prompts and takes a little longer; it does not change the price.
  - Default: `"high"`
  - Options: "low", "medium", "high"

- **`output_format`** (`string`, _optional_):
  The format of the output image.
  - Default: `"png"`
  - Options: "png", "jpeg", "webp"



**Required Parameters Example**:

```json
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "images": []
}
```

**Full Example**:

```json
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "images": [],
  "mask_image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "markup_image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "aspect_ratio": "1:1",
  "resolution": "1k",
  "quality": "medium",
  "complexity": "high",
  "output_format": "png"
}
```

### Result Data Schema

The `data` object returned by the API has the following fields:

- **`created_at`** (`string (date-time)`, _optional_):
  ISO timestamp of when the request was created (e.g., "2023-04-01T12:34:56.789Z").

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction, the ID of the prediction to get.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array of string | object`, _optional_):
  Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model.

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example `data` Object**:

```json
{
  "created_at": "example",
  "id": "example",
  "model": "example",
  "outputs": [],
  "status": "example",
  "urls": {}
}
```

## Usage Examples

The examples use `jq` to read JSON. Set your API key first:

```bash
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
```

### 1. Submit a prediction

```bash
REQUEST_BODY=$(cat <<'JSON'
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "images": []
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/openai/gpt-image-2.6-sunburst/edit \
  --header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data "${REQUEST_BODY}")

printf '%s\n' "${SUBMIT_RESPONSE}" | jq .
```

The response contains the prediction ID in `data.id`.

### 2. Poll until complete and read `outputs`

```bash
PREDICTION_ID=$(printf '%s' "${SUBMIT_RESPONSE}" | jq -r '.data.id')
if [ -z "${PREDICTION_ID}" ] || [ "${PREDICTION_ID}" = "null" ]; then
  printf 'Submission response did not contain data.id\n' >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    --request GET \
    --url "${RESULT_URL}" \
    --header "Authorization: Bearer ${WAVESPEED_API_KEY}")

  RESULT=$(printf '%s' "${RESPONSE}" | jq -e '.data')
  STATUS=$(printf '%s' "${RESULT}" | jq -er '.status')
  case "${STATUS}" in
    completed)
      # Generated files are returned in the outputs array.
      printf '%s\n' "${RESULT}" | jq '.outputs'
      break
      ;;
    failed|cancelled|timeout|deleted)
      printf '%s\n' "${RESULT}" | jq '{status, error, code}'
      exit 1
      ;;
    *)
      sleep 2
      ;;
  esac
done
```

## Additional Resources

### Documentation

- [Model Playground](https://wavespeed.ai/models/openai/gpt-image-2.6-sunburst/edit)
- [API Documentation](https://wavespeed.ai/docs/docs-api/openai/openai-gpt-image-2.6-sunburst-edit)