# openai/gpt-image-2/edit

> OpenAI's premier instruction-driven editing model enables "semantic-level" pixel reimagining through natural language and multiple reference images; it completely eliminates the need for complex masking, precisely preserving subject features and perfectly rendering multi-language text to help you achieve industrial-grade character outfitting, product composition, and UI redesign.

## Overview

- **Endpoint**: `https://api.shortapi.ai/api/v1/job/create`
- **Model ID**: `openai/gpt-image-2/edit`
- **Category**: image-to-image
- **Kind**: inference

## Pricing

Per request: $0.06

For more details, please check our pricing page.

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.

### Input Schema

The API accepts the following input parameters:

- **`prompt`** (`string`, _required_):
  Text prompt
  - Examples: "An action shot of a black lab swimming..."

- **`images`** (`list<string>`, _required_):
  The URLs of the images to use for image-to-image generation or image editing. Maximum 16 images

### Output Schema

The API returns a JSON response with a `job_id` for tracking the request status.

**Create Job Response:**
```json
{
  "code": 0,
  "data": {
    "amount": "0.02",
    "job_id": "<JOB_ID>"
  }
}
```

**Query Job Result (when status is 2, meaning succeeded):**
```json
{
  "code": 0,
  "data": {
    "status": 2,
    "result": {
      "images": [{ "url": "https://..." }]
    }
  }
}
```

## Use Example

To use this model, make an HTTP POST request to the API endpoint, then poll for results using the returned `job_id`.

### Bash (cURL)
```bash
# Step 1: Create a job
response=$(curl --request POST \
  --url https://api.shortapi.ai/api/v1/job/create \
  --header "Authorization: Bearer $SHORTAPI_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "openai/gpt-image-2/edit",
  "args": {
    "prompt": "take a photo with Sam Altman in the conference room",
    "images": ["https://file.shortapi.ai/assets/examples/openai/gpt-image-2/edit-images-1.png"]
  },
  "callback_url": "CALLBACK_URL"
}')
JOB_ID=$(echo "$response" | grep -o '"job_id": *"[^"]*"' | sed 's/"job_id": *//; s/"//g')

# Step 2: Poll for results
curl --request GET \
  --url "https://api.shortapi.ai/api/v1/job/query?id=$JOB_ID" \
  --header "Authorization: Bearer $SHORTAPI_KEY"
```

### JavaScript (Fetch API)
```javascript
// Step 1: Create a job
const response = await fetch(`https://api.shortapi.ai/api/v1/job/create`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${SHORTAPI_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "model": "openai/gpt-image-2/edit",
    "args": {
      "prompt": "take a photo with Sam Altman in the conference room",
      "images": ["https://file.shortapi.ai/assets/examples/openai/gpt-image-2/edit-images-1.png"]
    },
    "callback_url": "CALLBACK_URL"
})
});
const data = await response.json();
const JOB_ID = data.job_id;

// Step 2: Poll for results
const result = await fetch(`https://api.shortapi.ai/api/v1/job/query?id=${JOB_ID}`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${SHORTAPI_KEY}`
  }
});
const resultData = await result.json();
console.log(resultData);
```

### Python (Requests)
```python
import requests

# Step 1: Create a job
url = "https://api.shortapi.ai/api/v1/job/create"
payload = {
  "model": "openai/gpt-image-2/edit",
  "args": {
    "prompt": "take a photo with Sam Altman in the conference room",
    "images": ["https://file.shortapi.ai/assets/examples/openai/gpt-image-2/edit-images-1.png"]
  },
  "callback_url": "CALLBACK_URL"
}
headers = {
    "Authorization": f"Bearer {SHORTAPI_KEY}",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json=payload)
data = response.json()
JOB_ID = data.get("job_id")

# Step 2: Poll for results
result_url = f"https://api.shortapi.ai/api/v1/job/query?id={JOB_ID}"
result = requests.get(result_url, headers={"Authorization": f"Bearer {SHORTAPI_KEY}"})
print(result.json())
```