# GPT Image 2.5 API Documentation

> LLM-optimized documentation for GPT Image 2.5. Copy into your AI assistant for integration help.

## Overview

**Model ID:** `gpt-image-2-5`
**Type:** Image Generation
**Credit Cost:** 2 credits per image

OpenAI GPT Image 2.5 in two variants: Sunburst for premium reference-faithful renders and edits, Flare for the same quality tier at half the latency. Up to 4K output, optional reference images and masks.

## Endpoint

```
POST https://pixeldojo.ai/api/v1/models/gpt-image-2-5/run
```

## Authentication

All requests require an API key in the Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```

Get your API key: https://pixeldojo.ai/api-platform/api-keys

## Input Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | Yes | - | Text description of the image to generate, or the edit instruction when image_urls is supplied |
| `model` | enum | No | sunburst | GPT Image 2.5 variant. "sunburst" is the premium model (strongest reference preservation and layout handling); "flare" is the fast model at roughly half the latency. (Options: sunburst, flare) |
| `image_urls` | array | No | - | Optional reference image URLs (up to 8). With references the prompt is treated as an edit or composition instruction and each image costs 0.5 credits more; without them it is plain text-to-image. |
| `mask_url` | string | No | - | Optional inpainting mask, used together with image_urls. White marks the area to edit, black is preserved. |
| `image_size` | enum | No | 1024x1024 | Output image dimensions (Options: 1024x768, 1024x1024, 1024x1536, 1920x1088, 2560x1440...) |
| `quality` | enum | No | high | Generation quality tier. 4K outputs double the credit cost at medium and high. (Options: low, medium, high) |
| `num_images` | integer | No | 1 | Number of images to generate (1-4) (min: 1, max: 4) |
| `output_format` | enum | No | png | Image output format (Options: png, jpeg, webp) |

## Supported Aspect Ratios

- `1:1`
- `4:3`
- `2:3`
- `16:9`

## Capabilities

- Text to Image
- Image to Image

## Quick Start

### 1. Submit a Job

```bash
curl -X POST "https://pixeldojo.ai/api/v1/models/gpt-image-2-5/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a watercolor fox",
    "model": "sunburst",
    "quality": "high",
    "image_size": "1024x1024"
  }'
```

**Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123",
  "creditCost": 2,
  "creditsRemaining": 95
}
```

### 2. Poll for Results

```bash
curl "https://pixeldojo.ai/api/v1/jobs/job_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

**Completed Response:**
```json
{
  "jobId": "job_abc123...",
  "status": "completed",
  "output": {
    "images": ["https://temp.pixeldojo.ai/..."]
  },
  "creditCost": 2
}
```

## Python Example

```python
import requests
import time

API_KEY = "YOUR_API_KEY"

# Submit job
response = requests.post(
    "https://pixeldojo.ai/api/v1/models/gpt-image-2-5/run",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "prompt": "a watercolor fox",
        "model": "sunburst",
        "quality": "high",
        "image_size": "1024x1024"
    }
)

job = response.json()
job_id = job["jobId"]

# Poll for completion
while True:
    status_response = requests.get(
        f"https://pixeldojo.ai/api/v1/jobs/{'{job_id}'}",
        headers={"Authorization": f"Bearer {API_KEY}"}
    )
    status = status_response.json()
    
    if status["status"] == "completed":
        print("Output:", status["output"])
        break
    elif status["status"] == "failed":
        print("Error:", status.get("error"))
        break
    
    time.sleep(2)
```

## JavaScript Example

```javascript
const API_KEY = 'YOUR_API_KEY';

// Submit job
const submitResponse = await fetch('https://pixeldojo.ai/api/v1/models/gpt-image-2-5/run', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "prompt": "a watercolor fox",
    "model": "sunburst",
    "quality": "high",
    "image_size": "1024x1024"
  })
});

const job = await submitResponse.json();

// Poll for completion
const pollForResult = async (jobId) => {
  while (true) {
    const statusResponse = await fetch(`https://pixeldojo.ai/api/v1/jobs/${jobId}`, {
      headers: { 'Authorization': `Bearer ${API_KEY}` }
    });
    const status = await statusResponse.json();
    
    if (status.status === 'completed') return status.output;
    if (status.status === 'failed') throw new Error(status.error);
    
    await new Promise(r => setTimeout(r, 2000));
  }
};

const output = await pollForResult(job.jobId);
console.log('Output:', output);
```

## Error Codes

| Code | Status | Description |
|------|--------|-------------|
| `unauthorized` | 401 | Invalid or missing API key |
| `insufficient_credits` | 402 | Not enough credits |
| `invalid_request` | 400 | Invalid parameters |
| `model_not_found` | 404 | Model ID not found |
| `internal_error` | 500 | Server error |

## Links

- **Full Documentation:** https://pixeldojo.ai/api-platform/gpt-image-2-5
- **API Keys:** https://pixeldojo.ai/api-platform/api-keys
- **Buy Credits:** https://pixeldojo.ai/api-platform/buy-credits
- **All Models:** https://pixeldojo.ai/api/v1/models
- **OpenAPI Spec:** https://pixeldojo.ai/api/openapi