> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jiekou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GPT Image

Os parâmetros e o modo de uso estão alinhados com a documentação oficial; para parâmetros detalhados, consulte diretamente a documentação oficial.

## Como chamar

* `https://{api_domain}/openai/v1/images/generations`
* `https://{api_domain}/openai/v1/images/edits`

BaseURL:

* `https://{api_domain}/openai/v1`

## Modelos suportados

* `gpt-image-2`
* `gpt-image-2-oai`
* `gpt-image-2.5-sunburst-oai`
* `gpt-image-2.5-flare-oai`

## Descrição

Esta API é compatível com a OpenAI Image API e atualmente oferece suporte à geração e edição de imagens. Para parâmetros detalhados, prevalece a documentação oficial da OpenAI:

* [Guia oficial de geração de imagens da OpenAI](https://developers.openai.com/api/docs/guides/image-generation)

* [Images generate](https://developers.openai.com/api/reference/resources/images/methods/generate)

* [Images edit](https://developers.openai.com/api/reference/resources/images/methods/edit)

* As solicitações de geração de imagens usam `application/json`.

* A edição de imagens oferece suporte ao upload de arquivos via `multipart/form-data`, bem como ao `application/json`, usando o array `images` para passar referências de imagens; um exemplo em JSON é fornecido abaixo.

* Recomenda-se definir explicitamente `size` e `quality` para facilitar o controle da qualidade das imagens e dos custos. As cobranças são calculadas com base no consumo real de Tokens e no preço do modelo; o consumo pode ser verificado no campo `usage` da resposta.

## Modelos e parâmetros

* Use `gpt-image-2.5-sunburst-oai` para edições de imagem refinadas, ou `gpt-image-2.5-flare-oai` para geração rápida de imagens. No campo `model` da solicitação, use os nomes completos listados acima.
* Valores de `quality` para o 2.5: `low` / `medium` / `high` / `xhigh` / `max` / `auto`, com padrão `auto`; o GPT Image 2 não oferece suporte aos novos valores `xhigh` / `max`.
* Para gerar imagens com fundo transparente, defina `background="transparent"` e use `output_format="png"` ou `"webp"`.
* Defina o tamanho da imagem por meio de `size`, por exemplo `1024x1024`, `1536x1024` ou `1024x1536`. Para restrições de tamanhos personalizados e a descrição completa dos parâmetros, consulte a [documentação oficial](https://developers.openai.com/api/docs/guides/image-generation).

## REST API

### 1. Geração de imagens

```bash theme={null}
curl -X POST 'https://{api_domain}/openai/v1/images/generations' \
  -H 'Authorization: Bearer apikey' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "gpt-image-2.5-flare-oai",
    "prompt": "A product photo of a white ceramic mug on a wooden table",
    "size": "1024x1024",
    "quality": "high",
    "output_format": "png",
    "n": 1
  }' | jq -r '.data[0].b64_json' | base64 --decode > output.png
```

### 2. Edição de imagens

```bash theme={null}
curl -X POST 'https://{api_domain}/openai/v1/images/edits' \
  -H 'Authorization: Bearer apikey' \
  -F 'model=gpt-image-2' \
  -F 'image[]=@input.png' \
  -F 'mask=@mask.png' \
  -F 'prompt=Replace the background with a clean studio backdrop' \
  -F 'size=1024x1024' \
  -F 'quality=high' \
  -F 'output_format=png' \
  | jq -r '.data[0].b64_json' | base64 --decode > edited.png
```

Ao editar com múltiplas imagens de referência, é possível passar `image[]` várias vezes:

```bash theme={null}
curl -X POST 'https://{api_domain}/openai/v1/images/edits' \
  -H 'Authorization: Bearer apikey' \
  -F 'model=gpt-image-2' \
  -F 'image[]=@body-lotion.png' \
  -F 'image[]=@bath-bomb.png' \
  -F 'image[]=@soap.png' \
  -F 'prompt=Create a photorealistic gift basket using the reference products' \
  -F 'size=1024x1024' \
  -F 'quality=high'
```

### 3. Edição de imagens (JSON)

Substitua `{base64_image}` pela codificação Base64 da imagem PNG de entrada.

```bash theme={null}
curl -X POST 'https://{api_domain}/openai/v1/images/edits' \
  -H 'Authorization: Bearer {your-api-key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "gpt-image-2.5-sunburst-oai",
    "images": [
      {"image_url": "data:image/png;base64,{base64_image}"}
    ],
    "prompt": "Change the shape to green. Preserve the simple composition.",
    "size": "1024x1024",
    "quality": "xhigh",
    "moderation": "low",
    "output_format": "png"
  }'
```

## OpenAI SDK

### Python

```python theme={null}
from openai import OpenAI
import base64

api_key = "{your-api-key}"

client = OpenAI(
    api_key=api_key,
    base_url="https://{api_domain}/openai/v1",
)

result = client.images.generate(
    model="gpt-image-2.5-flare-oai",
    prompt="A product photo of a white ceramic mug on a wooden table",
    size="1024x1024",
    quality="high",
)

image_base64 = result.data[0].b64_json
with open("output.png", "wb") as f:
    f.write(base64.b64decode(image_base64))
```

Edição de imagens:

```python theme={null}
from openai import OpenAI
import base64

api_key = "{your-api-key}"

client = OpenAI(
    api_key=api_key,
    base_url="https://{api_domain}/openai/v1",
)

result = client.images.edit(
    model="gpt-image-2",
    image=open("input.png", "rb"),
    mask=open("mask.png", "rb"),
    prompt="Replace the background with a clean studio backdrop",
    size="1024x1024",
    quality="high",
)

image_base64 = result.data[0].b64_json
with open("edited.png", "wb") as f:
    f.write(base64.b64decode(image_base64))
```

### Node.js

```javascript theme={null}
import OpenAI from "openai";
import fs from "fs";

const client = new OpenAI({
  apiKey: "{your-api-key}",
  baseURL: "https://{api_domain}/openai/v1",
});

const result = await client.images.generate({
  model: "gpt-image-2.5-flare-oai",
  prompt: "A product photo of a white ceramic mug on a wooden table",
  size: "1024x1024",
  quality: "high",
});

const imageBase64 = result.data[0].b64_json;
fs.writeFileSync("output.png", Buffer.from(imageBase64, "base64"));
```

Edição de imagens:

```javascript theme={null}
import OpenAI, { toFile } from "openai";
import fs from "fs";

const client = new OpenAI({
  apiKey: "{your-api-key}",
  baseURL: "https://{api_domain}/openai/v1",
});

const result = await client.images.edit({
  model: "gpt-image-2",
  image: await toFile(fs.createReadStream("input.png"), null, {
    type: "image/png",
  }),
  mask: await toFile(fs.createReadStream("mask.png"), null, {
    type: "image/png",
  }),
  prompt: "Replace the background with a clean studio backdrop",
  size: "1024x1024",
  quality: "high",
});

const imageBase64 = result.data[0].b64_json;
fs.writeFileSync("edited.png", Buffer.from(imageBase64, "base64"));
```

## Boas práticas

### Parâmetro moderation

* `moderation="auto"` é a filtragem padrão; `moderation="low"` indica uma filtragem mais permissiva.
* `moderation` pode ser usado em solicitações de geração e edição de imagens.