# GPT Image 2.5 Sunburst

GPT Image 2.5 Sunburst Edit Image is available in the Business API catalog.

- Model ID: `openai/gpt-image-2.5-sunburst/image-to-image`
- Provider: OpenAI
- Modality: image → image
- Type: Image to Image
- Status: stable
- Delivery: async
- Max resolution: 4K
- Output format: png
- Aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9

## Authentication

Send your API key in the `X-API-Key` header.

The same key reads the org balance at `GET https://api.dev.pika.art/billing/balance`, which is free to call and confirms the request can be paid for before you submit it.

## Endpoint

```
POST https://api.dev.pika.art/v1/media/openai/gpt-image-2.5-sunburst/image-to-image
```

## Reference uploads

To use a local file (image, audio, or video) as a model input, first request a presigned upload URL: `POST /v1/media/uploads` with the `X-API-Key` header and a JSON body `{ "content_type": "image/png", "size_bytes": 12345 }`, where `size_bytes` is the file's exact byte length. The response returns `upload_url` (temporary, valid for 5 minutes), `headers`, and `url` (the permanent Pika URL). PUT the file bytes to `upload_url` sending the returned `headers` verbatim — both `Content-Type` and `Content-Length` are signed, and storage returns a bare 403 if either is missing or differs. Then pass `url` into fields such as `image`, `image_url`, `end_image_url`, `image_urls`, `first_frame_image`, or `mask_image_url`.

## Generate

`POST /v1/media/openai/gpt-image-2.5-sunburst/image-to-image`

```bash
curl -X POST https://api.dev.pika.art/v1/media/openai/gpt-image-2.5-sunburst/image-to-image \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prompt": "Using the supplied photograph as the base, keep its composition, camera angle, framing and lighting, and keep every element not named below exactly as it is. Keep the torn cut-paper collage treatment and the\ntopiary garden. Change only the following. Keep the transparent background and edge of the artwork.\n\nThe existing figure is now in full profile to camera, mid-stride and not looking at the camera, walking a great dane on a lead. Their coat changes from royal blue to a black-and-white cow-print coat.\n\nAdd a second figure walking in the opposite direction: an invented man walking a fluffy ginger cat on a lead, wearing an oversized charcoal peacoat and baggy pale-pink corduroy trousers.\n\nBoth figures and both animals are built from the same torn cut-paper collage material as the rest of the scene — layered fragments of coloured paper with visible torn fibrous edges, slightly offset and\nmis-registered.\n\nLighting stays as it is: one enormous softbox, fully diffused, soft and even, no hard shadows. Fine medium-format film grain. Colour soft but vibrant, never oversaturated, never dull. Any people are entirely fictional invented individuals, anatomically correct and complete. No text, no logos, no\nwatermark.",
  "num_images": 1,
  "aspect_ratio": "16:9",
  "output_format": "png",
  "resolution": "1K",
  "image_urls": [
    "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/7364d1f8a24840408bedc908790be67e.png"
  ],
  "quality": "medium"
}'
```

### Request body

| Param | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `prompt` | string | yes | - | Text prompt describing the image to generate. |
| `num_images` | integer (1 – 10) | no | 1 | Number of images to generate. |
| `aspect_ratio` | enum | no | 1:1 | Output aspect ratio. Ignored when 'size' is set. |
| `output_format` | enum | no | png | Image file format of the output. |
| `resolution` | enum | no | 1K | Output resolution. |
| `background` | enum | no | - | Background of the output. 'transparent' needs a png or webp output_format. |
| `size` | string | no | - | Explicit output size as 'WxH' (e.g. '1024x1024'), or 'auto' to let the provider choose. Overrides aspect_ratio and resolution. |
| `image_urls` | string[] (1 – 16) | yes | - | URLs of the source images to edit. |
| `mask_image_url` | string | no | - | Mask URL marking the region to edit (transparent areas are edited). Must be a PNG with an alpha channel; the provider rejects masks without one. |
| `quality` | enum | no | medium | Rendering quality of the output. |

#### Example body

```json
{
  "prompt": "Using the supplied photograph as the base, keep its composition, camera angle, framing and lighting, and keep every element not named below exactly as it is. Keep the torn cut-paper collage treatment and the\ntopiary garden. Change only the following. Keep the transparent background and edge of the artwork.\n\nThe existing figure is now in full profile to camera, mid-stride and not looking at the camera, walking a great dane on a lead. Their coat changes from royal blue to a black-and-white cow-print coat.\n\nAdd a second figure walking in the opposite direction: an invented man walking a fluffy ginger cat on a lead, wearing an oversized charcoal peacoat and baggy pale-pink corduroy trousers.\n\nBoth figures and both animals are built from the same torn cut-paper collage material as the rest of the scene — layered fragments of coloured paper with visible torn fibrous edges, slightly offset and\nmis-registered.\n\nLighting stays as it is: one enormous softbox, fully diffused, soft and even, no hard shadows. Fine medium-format film grain. Colour soft but vibrant, never oversaturated, never dull. Any people are entirely fictional invented individuals, anatomically correct and complete. No text, no logos, no\nwatermark.",
  "num_images": 1,
  "aspect_ratio": "16:9",
  "output_format": "png",
  "resolution": "1K",
  "image_urls": [
    "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/7364d1f8a24840408bedc908790be67e.png"
  ],
  "quality": "medium"
}
```

### Accepted values

| Param | Values | Default |
| --- | --- | --- |
| `aspect_ratio` | `1:1`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `9:16`, `16:9`, `21:9` | `1:1` |
| `output_format` | `png`, `jpeg`, `webp` | `png` |
| `resolution` | `1K`, `2K`, `4K` | `1K` |
| `background` | `auto`, `opaque`, `transparent` | — |
| `quality` | `low`, `medium`, `high`, `xhigh`, `max` | `medium` |

Returns a job object, not the final output — normally with status `queued`. Store the `id` and poll until a terminal state. A rejected submit (insufficient balance, rate limit, unpriceable input) still returns the job object, with status `failed` and `error` set. An `Idempotency-Key` replay returns the existing job in its current state — including `failed`, so retry a failure with a fresh key, never the same one.

### Response

**200 OK · queued**

```json
{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "queued"
}
```

## Poll status

`GET /v1/media/jobs/{request_id}`

```bash
curl https://api.dev.pika.art/v1/media/jobs/{request_id} \
  -H "X-API-Key: YOUR_API_KEY"
```

Poll the job by id until it reaches a terminal state: `completed` or `failed`.

### The job object

- `id` (string): Unique identifier for the job.
- `status` (enum): One of `queued`, `running`, `completed`, `failed`.
- `output` (object): Present once the job completes.
  - `media_type` (enum): `image`.
  - `output.images[].url` (string): URLs of the generated images.
- `error` (object): Present if the job failed. `error.code` is the stable machine-readable value to branch on — one of `invalid_input`, `content_moderation`, `provider_error`, `provider_timeout`, `provider_unavailable`, `rate_limited`, `insufficient_balance`, `membership_required`, `cycle_limit_exceeded`, `admission_suspended`, `timed_out`, `internal`. Unrecognized values normalize to `provider_error`. `error.message` is diagnostic text and varies.
- `usage` (object): Units the provider reported for the job, such as `video_output_tokens`, `image_output_tokens`, `input_tokens`, or `output_seconds`. Present once the job is terminal, carries only the units the job reports, and is `null` when nothing was reported. It may not reproduce the charge, because some pricing components are fixed by the request; the charge is authoritative.
- `billing` (object): What the job charged. Present once the job is terminal, `null` on the submit response and on webhooks. `billing.state` is one of `settled`, `pending`, `unavailable`. `settled` carries `charge_micro_usd`, the amount collected in micro-USD (the balance's unit), `0` included. `pending` means the charge is still settling: retry at 1s, 2s, then 5s. `unavailable` means the billing read failed on Pika's side: retry no sooner than 30s. Record spend only when `state` is `settled`, keyed by job id; a `billing` of `null` is not a charge.

### Response

**200 OK · running**

```json
{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "running"
}
```

**200 OK · completed**

```json
{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "completed",
  "output": {
    "media_type": "image",
    "images": [
      {
        "url": "https://api.dev.pika.art/v1/files/img_8f3a2c91.png",
        "content_type": "image/png"
      }
    ]
  },
  "usage": {
    "image_output_tokens": 1568
  },
  "billing": {
    "state": "settled",
    "charge_micro_usd": 52000
  }
}
```

**200 OK · failed**

```json
{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "failed",
  "error": {
    "code": "provider_error",
    "message": "upstream generation failed"
  },
  "billing": {
    "state": "settled",
    "charge_micro_usd": 0
  }
}
```

A completed job carries its download URL in `output`. `GET /v1/media/jobs/{request_id}/content` returns that same URL as `{ "url": "..." }` for clients that only kept the id; it answers `409` until the job completes.

## Errors

Errors use conventional HTTP status codes and always return JSON, in one of two shapes. Request-level errors (auth, unknown path, schema validation, idempotency conflict) are `{"message": "..."}`. Submit rejections that occur after the job row is created (insufficient balance, rate limit, unpriceable input, dispatch unavailable) return the full failed job envelope — branch on `error.code`, and retry with a fresh `Idempotency-Key`, since a failed job replays on its key.

- 401 Unauthorized — The API key is missing or invalid. Body: `{"message":"Invalid API key"}`
- 403 Forbidden — An inactive key is rejected with a `{"message"}` body. A submit that the org balance or postpaid cycle limit cannot cover is rejected after the job row exists and returns the failed job envelope. `GET /billing/balance` separates the two: a `200` means the key is active, so the rejection was the balance or the cycle limit. Body: `{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"insufficient_balance","message":"Insufficient org balance"}}`
- 404 Not Found — No job with that id exists in your org, or the media path names an unknown vendor/model/function. Body: `{"message":"media job not found"}`
- 409 Conflict — The result was requested before the job completed, or an Idempotency-Key header was reused with a different body. Body: `{"message":"media job is not ready"}`
- 422 Unprocessable Entity — The request body failed validation: an invalid enum value, a missing required field, a wrong type, or malformed JSON. The JSON message names the offending field. A schema-valid parameter combination that cannot be priced instead fails after job creation and returns the failed job envelope with error code `invalid_input`. Body: `{"message":"duration: Input should be less than or equal to 15"}`
- 429 Too Many Requests — Org limit reached: requests per minute or day, or concurrent jobs. Returned as the failed job envelope; check the Retry-After header and retry with a fresh Idempotency-Key. Body: `{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"rate_limited","message":"rate limit exceeded: rpm"}}`
- 503 Service Unavailable — The model rail or a backend dependency is temporarily unavailable. Returned as the failed job envelope; retry with backoff and a fresh Idempotency-Key. Body: `{"id":"media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0","status":"failed","error":{"code":"provider_unavailable","message":"media dispatch unavailable"}}`

## Pricing

- Image output: $30 per 1M tokens
- Input: $5 per 1M tokens
- Image input: $8 per 1M tokens

Only successful generations are charged.

Check the balance against this price before submitting: `GET https://api.dev.pika.art/billing/balance` returns `balance_micro_usd`, which is US dollars multiplied by 1,000,000, and `postpaid` when the org bills by invoice instead. For an active postpaid org, compare the price against `postpaid.cycle.remaining_micro_usd` rather than the prepaid balance. Report a shortfall to the user rather than submitting a request the balance cannot cover.

---

Model page: https://dev.pika.art/models/openai/gpt-image-2.5-sunburst/image-to-image
API index: https://dev.pika.art/llms.txt
