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

# Geração de imagens GPT-Image(1/1.5)

>  - Modo de processamento assíncrono, retorna ID da tarefa para consultas posteriores
- Suporta modos de geração a partir de texto, a partir de imagem e inpainting
- Suporta fundos transparentes, múltiplos formatos de saída e níveis de qualidade
- Gere até 4 imagens por requisição, com até 15 imagens de referência 

```bash cURL theme={null}
curl --request POST \
  --url https://gccai.heqingsong.uk/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-1-official",
    "prompt": "An ancient castle under a starry sky",
    "size": "1:1",
    "quality": "auto",
    "n": 1
  }'
```

```python Python theme={null}
import requests

url = "https://gccai.heqingsong.uk/v1/images/generations"

payload = {
    "model": "gpt-image-1-official",
    "prompt": "An ancient castle under a starry sky",
    "size": "1:1",
    "quality": "auto",
    "n": 1
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript JavaScript theme={null}
const url = "https://gccai.heqingsong.uk/v1/images/generations";

const payload = {
  model: "gpt-image-1-official",
  prompt: "An ancient castle under a starry sky",
  size: "1:1",
  quality: "auto",
  n: 1,
};

const headers = {
  Authorization: "Bearer <token>",
  "Content-Type": "application/json",
};

fetch(url, {
  method: "POST",
  headers: headers,
  body: JSON.stringify(payload),
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));
```

```go Go theme={null}
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://gccai.heqingsong.uk/v1/images/generations"

    payload := map[string]interface{}{
        "model":   "gpt-image-1-official",
        "prompt":  "An ancient castle under a starry sky",
        "size":    "1:1",
        "quality": "auto",
        "n":       1,
    }

    jsonData, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    req.Header.Set("Authorization", "Bearer <token>")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}
```

```java Java theme={null}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://gccai.heqingsong.uk/v1/images/generations";

        String payload = """
        {
          "model": "gpt-image-1-official",
          "prompt": "An ancient castle under a starry sky",
          "size": "1:1",
          "quality": "auto",
          "n": 1
        }
        """;

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```php PHP theme={null}
<?php

$url = "https://gccai.heqingsong.uk/v1/images/generations";

$payload = [
    "model" => "gpt-image-1-official",
    "prompt" => "An ancient castle under a starry sky",
    "size" => "1:1",
    "quality" => "auto",
    "n" => 1
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

```ruby Ruby theme={null}
require 'net/http'
require 'json'
require 'uri'

url = URI("https://gccai.heqingsong.uk/v1/images/generations")

payload = {
  model: "gpt-image-1-official",
  prompt: "An ancient castle under a starry sky",
  size: "1:1",
  quality: "auto",
  n: 1
}

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = payload.to_json

response = http.request(request)
puts response.body
```

```swift Swift theme={null}
import Foundation

let url = URL(string: "https://gccai.heqingsong.uk/v1/images/generations")!

let payload: [String: Any] = [
    "model": "gpt-image-1-official",
    "prompt": "An ancient castle under a starry sky",
    "size": "1:1",
    "quality": "auto",
    "n": 1
]

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let error = error {
        print("Error: \(error)")
        return
    }

    if let data = data, let responseString = String(data: data, encoding: .utf8) {
        print(responseString)
    }
}

task.resume()
```

```csharp C# theme={null}
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var url = "https://gccai.heqingsong.uk/v1/images/generations";

        var payload = @"{
            ""model"": ""gpt-image-1-official"",
            ""prompt"": ""An ancient castle under a starry sky"",
            ""size"": ""1:1"",
            ""quality"": ""auto"",
            ""n"": 1
        }";

        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

        var content = new StringContent(payload, Encoding.UTF8, "application/json");
        var response = await client.PostAsync(url, content);
        var result = await response.Content.ReadAsStringAsync();

        Console.WriteLine(result);
    }
}
```

```dart Dart theme={null}
import 'dart:convert';
import 'package:http/http.dart' as http;

void main() async {
  final url = Uri.parse('https://gccai.heqingsong.uk/v1/images/generations');

  final payload = {
    'model': 'gpt-image-1-official',
    'prompt': 'An ancient castle under a starry sky',
    'size': '1:1',
    'quality': 'auto',
    'n': 1,
  };

  final response = await http.post(
    url,
    headers: {
      'Authorization': 'Bearer <token>',
      'Content-Type': 'application/json',
    },
    body: jsonEncode(payload),
  );

  print(response.body);
}
```

```r R theme={null}
library(httr)
library(jsonlite)

url <- "https://gccai.heqingsong.uk/v1/images/generations"

payload <- list(
  model = "gpt-image-1-official",
  prompt = "An ancient castle under a starry sky",
  size = "1:1",
  quality = "auto",
  n = 1
)

response <- POST(
  url,
  add_headers(
    Authorization = "Bearer <token>",
    `Content-Type` = "application/json"
  ),
  body = toJSON(payload, auto_unbox = TRUE),
  encode = "raw"
)

cat(content(response, "text"))
```

```json 200 theme={null}
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KXXXXXXXXXXXXXXX"
    }
  ]
}
```

```json 400 theme={null}
{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "invalid_request_error"
  }
}
```

```json 401 theme={null}
{
  "error": {
    "code": 401,
    "message": "Authentication failed, please check your API key",
    "type": "authentication_error"
  }
}
```

```json 402 theme={null}
{
  "error": {
    "code": 402,
    "message": "Insufficient balance, please top up and try again",
    "type": "payment_required"
  }
}
```

```json 403 theme={null}
{
  "error": {
    "code": 403,
    "message": "Access forbidden, you do not have permission to access this resource",
    "type": "permission_error"
  }
}
```

```json 429 theme={null}
{
  "error": {
    "code": 429,
    "message": "Too many requests, please try again later",
    "type": "rate_limit_error"
  }
}
```

```json 500 theme={null}
{
  "error": {
    "code": 500,
    "message": "Internal server error, please try again later",
    "type": "server_error"
  }
}
```

```json 502 theme={null}
{
  "error": {
    "code": 502,
    "message": "Bad gateway, server temporarily unavailable",
    "type": "bad_gateway"
  }
}
```

## Modelos suportados

| Modelo | Descrição | Modos | Geração a partir de imagem | Máx. de imagens | Cobrança |
| - | - | - | - | - | - |
| `gpt-image-1-official` | Estabilidade prioritária, adequado para geração de imagens em geral | Texto para imagem / Imagem para imagem | Suportado | 4 | Size x Quality |
| `gpt-image-1.5-official` | Nova versão, adequada para maior qualidade e edição complexa | Texto para imagem / Imagem para imagem | Suportado | 4 | Size x Quality |

## Autorizações

**Authorization** `string` *required*

Todas as requisições à API requerem autenticação por Bearer Token

Obtenha sua chave de API:

Acesse a [página de gerenciamento de chaves de API](https://gccai.heqingsong.uk/keys) para obter sua chave de API

Adicione o seguinte aos cabeçalhos da sua requisição:

```
Authorization: Bearer YOUR_API_KEY
```

## Body

**model** `string` *required*

Nome do modelo

* `gpt-image-1-official` - Estabilidade prioritária, adequado para geração de imagens em geral
* `gpt-image-1.5-official` - Nova versão, adequada para maior qualidade e edição complexa

**nsfw\_check** `boolean` (default: false)

Define se o conteúdo deve ser moderado antes do envio da tarefa de imagem.

* `true`: verificar prompts e imagens de entrada com `omni-moderation-latest`
* `false` ou omitido: não enviar solicitação de moderação, sem custo nem latência adicionais de moderação (padrão)

**prompt** `string` *required*

Descrição textual para geração da imagem, suporta tanto chinês quanto inglês

**size** `string` (default: 1:1)

Proporção da imagem

Proporções suportadas:

* `1:1` - Quadrado (padrão)
* `3:2` - Paisagem
* `2:3` - Retrato

**n** `integer` (default: 1)

Número de imagens a serem geradas

Intervalo: 1-4

* Valores ≤ 0 serão tratados como `1`
* Valores > 4 serão tratados como `4`

**Aviso:** Deve ser um número puro (ex.: `1`), não use aspas, caso contrário ocorrerá um erro

**quality** `string` (default: auto)

Qualidade da imagem

* `auto` - Seleção automática de qualidade (padrão)
* `low` - Mais rápido, mais econômico
* `medium` - Equilíbrio entre qualidade e custo
* `high` - Qualidade mais alta, custo mais alto

**background** `string` (default: auto)

Modo de fundo

* `auto` - Fundo automático (padrão)
* `opaque` - Fundo opaco
* `transparent` - Fundo transparente, recomendado com o formato de saída `png`

> [!WARNING]
>
> `background: transparent` não pode ser usado simultaneamente com `output_format: jpeg`

**moderation** `string` (default: auto)

Nível de moderação

* `auto` - Nível de moderação padrão
* `low` - Moderação mais permissiva

**output\_format** `string` (default: png)

Formato de saída

* `png` - Formato padrão, adequado para fundos transparentes
* `jpeg` - Tamanho de arquivo menor, adequado para saída de imagens em geral

> [!WARNING]
>
> `background: transparent` não pode ser usado simultaneamente com `output_format: jpeg`

**output\_compression** `integer`

Nível de compressão de saída, intervalo 0-100

* Recomendado apenas para `jpeg`
* Não recomendado para `png`

**image\_urls** `array`

Array de URLs de imagens de referência, ativa o modo imagem para imagem quando fornecido

**Detalhes**

* 1 imagem para edição com referência única
* 2-15 imagens para fusão com múltiplas referências
* Mais de 15 imagens serão rejeitadas
* Devem ser URLs de imagens publicamente acessíveis e estáveis

**Limite:** Até 15 imagens de referência

**mask\_url** `string`

URL da imagem de máscara para inpainting

* Deve ser usado em conjunto com `image_urls`
* Será submetida via a API oficial de edição

> [!WARNING]
>
> 1. Antes de fazer o upload da imagem de máscara, confirme que o canal Alpha da imagem está como "Sim".
>
> 2. O tamanho da imagem de máscara deve coincidir com a primeira imagem de referência.

## Referência de tamanhos

As proporções são usadas externamente; o sistema as mapeia automaticamente para as dimensões oficiais internamente.

| Proporção | Tamanho real | Descrição |
| - | - | - |
| `1:1` | 1024x1024 | Quadrado |
| `2:3` | 1024x1536 | Retrato |
| `3:2` | 1536x1024 | Paisagem |

## Exemplos de uso

**Texto para imagem (mínimo)**

```json theme={null}
{
  "model": "gpt-image-1-official",
  "prompt": "An ancient castle under a starry sky"
}
```

**Texto para imagem (parâmetros completos)**

```json theme={null}
{
  "model": "gpt-image-1-official",
  "prompt": "A flat icon of a glass bottle with no background",
  "size": "2:3",
  "quality": "high",
  "background": "transparent",
  "moderation": "low",
  "output_format": "png",
  "n": 1
}
```

**Imagem para imagem (referência única)**

```json theme={null}
{
  "model": "gpt-image-1.5-official",
  "prompt": "Convert the reference image to illustration style, preserving the main outline",
  "size": "1:1",
  "quality": "auto",
  "image_urls": [
    "https://your-cdn.com/input.png"
  ],
  "n": 1
}
```

**Imagem para imagem (fusão de múltiplas referências)**

```json theme={null}
{
  "model": "gpt-image-1.5-official",
  "prompt": "Merge two reference images into an illustration poster, preserving the main outlines",
  "size": "1:1",
  "quality": "auto",
  "background": "transparent",
  "image_urls": [
    "https://your-cdn.com/input-a.png",
    "https://your-cdn.com/input-b.png"
  ],
  "moderation": "low",
  "output_format": "png",
  "n": 1
}
```

**Múltiplas imagens (n > 1)**

```json theme={null}
{
  "model": "gpt-image-1-official",
  "prompt": "Four minimalist poster variations of a red fox",
  "size": "1:1",
  "quality": "low",
  "output_format": "png",
  "n": 4
}
```

## Response

**code** `integer`

Código de status da resposta

**data** `array`

Array de dados da resposta

**Propriedades**

**status** `string`

Status da tarefa

* `submitted` - Enviada

**task\_id** `string`

Identificador único da tarefa

## Observações

1. **Processamento assíncrono**: Após o envio, um `task_id` é retornado. Faça polling em `/v1/tasks/{task_id}` para obter os resultados
2. **Escolha do modelo**: Use `gpt-image-1-official` para geração de imagens em geral; use `gpt-image-1.5-official` para edição de alta qualidade e tarefas complexas de imagem para imagem
3. **Requisitos da URL da imagem**: Para imagem para imagem, use URLs de imagens publicamente acessíveis e estáveis
4. **Cobrança**: Cobrado por imagem gerada com sucesso; sem cobrança em caso de falha


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.