Saltar para o conteúdo principal
POST
/
v1
/
images
/
generations
curl --request POST \
  --url https://api.apimart.ai/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-2-official",
    "prompt": "An ancient castle beneath a starry sky",
    "size": "16:9",
    "resolution": "2k",
    "quality": "high",
    "n": 1
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPTXXXXXXXXXXXXXXX"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

curl --request POST \
  --url https://api.apimart.ai/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-2-official",
    "prompt": "An ancient castle beneath a starry sky",
    "size": "16:9",
    "resolution": "2k",
    "quality": "high",
    "n": 1
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPTXXXXXXXXXXXXXXX"
    }
  ]
}

Autorizações

Authorization
string
obrigatório
Todos os endpoints requerem autenticação por Bearer TokenObtenha sua chave de API:Acesse a página de gerenciamento de chaves de API para obter sua chave de APIInclua-a no cabeçalho da requisição:
Authorization: Bearer YOUR_API_KEY

Body

model
string
padrão:"gpt-image-2-official"
obrigatório
Nome do modelo de geração de imagensFixo em gpt-image-2-official (modelo oficial gpt-image-2 da OpenAI)
prompt
string
obrigatório
Descrição textual para a geração da imagem
  • Suporta inglês e chinês, descrições detalhadas são recomendadas
  • Moderação de conteúdo / revisão de segurança antes do envio — violações são rejeitadas imediatamente
size
string
padrão:"1:1"
Proporção da imagemExternamente, usa valores de proporção; internamente, é mapeada para pixels reais de acordo com resolution.Proporções suportadas, além de auto para deixar o servidor escolher uma proporção adequada automaticamente:
  • auto - Automático (o servidor escolhe uma proporção com base no prompt / imagens de referência)
  • 1:1 - Quadrado (padrão, avatares de redes sociais / logos)
  • 3:2 - Paisagem (proporção comum de DSLR)
  • 2:3 - Retrato (pôsteres verticais)
  • 4:3 - Paisagem (monitor clássico / apresentação de slides)
  • 3:4 - Retrato
  • 5:4 - Paisagem
  • 4:5 - Retrato (post vertical do Instagram)
  • 16:9 - Paisagem (miniatura de vídeo widescreen)
  • 9:16 - Retrato (tela cheia do celular / capa de vídeo curto)
  • 2:1 - Paisagem (banner web)
  • 1:2 - Retrato
  • 3:1 - Paisagem (banner ultrawide)
  • 1:3 - Retrato (pôster extra alto)
  • 21:9 - Paisagem (ultrawide cinematográfico)
  • 9:21 - Retrato
Dimensões em pixels também podem ser passadas diretamente, como 1881x836 / 887x1774.
Quando size é definido como auto, a proporção padrão é 1:1.
resolution
string
padrão:"1k"
Nível de resolução (novo campo)Controla a nitidez real da saída.
  • 1k - Linha de base 1024, custo-eficiente para uso diário (padrão)
  • 2k - Linha de base 2048, adequado para pôsteres / necessidades de alta definição
  • 4k - Linha de base 3840, suporta as 15 proporções na tabela de mapeamento abaixo
O 4K suporta as 15 proporções na tabela de mapeamento abaixo; você também pode passar as dimensões em pixels da tabela diretamente via size.
quality
string
padrão:"auto"
Qualidade da imagem
  • auto - Automático (padrão, normalmente equivalente a low)
  • low - Rápido e econômico, suficiente para esboços
  • medium - Balanceado
  • high - Precisão máxima (4K + high pode levar mais de 120s)
background
string
padrão:"auto"
Modo de fundo
  • auto - Automático (padrão)
  • opaque - Opaco
  • transparent - ⚠️ gpt-image-2-official não suporta fundos transparentes; o sistema rebaixa silenciosamente para auto
moderation
string
padrão:"auto"
Intensidade da moderação
  • auto - Intensidade de moderação padrão
  • low - Moderação mais permissiva
output_format
string
padrão:"png"
Formato de saída
  • png - Padrão
  • jpeg - Arquivos menores
  • webp - Ideal para navegadores modernos
output_compression
integer
Nível de compressão de saída, intervalo 0-100
  • Eficaz apenas para jpeg / webp
n
integer
padrão:"1"
Número de imagens a serem geradasIntervalo: 1 ~ 4
Deve ser um número puro (ex.: 1), não envolva em aspas
image_urls
array
Array de URLs de imagens de referência
mask_url
string
URL da imagem de máscara, usada para inpainting
  • Deve ser usada em conjunto com image_urls
  1. Certifique-se de que a imagem de máscara tenha um canal Alpha antes de fazer o upload.
  2. As dimensões da imagem de máscara devem coincidir com a primeira imagem de referência.

Mapeamento Size × Resolution

size × resolution → pixels reais da OpenAI (15 proporções × 3 níveis):
size1k2k4k
1:11024×10242048×20482880×2880
3:21536×10242048×13603520×2336
2:31024×15361360×20482336×3520
4:31024×7682048×15363312×2480
3:4768×10241536×20482480×3312
5:41280×10242560×20483216×2576
4:51024×12802048×25602576×3216
16:91536×8642048×11523840×2160
9:16864×15361152×20482160×3840
2:12048×10242688×13443840×1920
1:21024×20481344×26881920×3840
3:11881×836 / 1536×5123072×10243840×1280
1:3887×1774 / 512×15361024×30721280×3840
21:92016×8642688×11523840×1648
9:21864×20161152×26881648×3840
Observação: Algumas dimensões são aproximadas com base em múltiplos de 16 e limites de pixel, como 3:2 / 2:3 @ 2K sendo 2048×1360 e 21:9 @ 4K sendo 3840×1648. Use os pixels reais da tabela como fonte da verdade.

Exemplos de uso

Texto para imagem (requisição mínima)
{
  "model": "gpt-image-2-official",
  "prompt": "An ancient castle beneath a starry sky"
}
Pôster em 2K de alta definição
{
  "model": "gpt-image-2-official",
  "prompt": "Cyberpunk night scene",
  "size": "16:9",
  "resolution": "2k",
  "quality": "high",
  "output_format": "jpeg",
  "output_compression": 90
}
Wallpaper em 4K
{
  "model": "gpt-image-2-official",
  "prompt": "Snow mountain sunrise panorama",
  "size": "16:9",
  "resolution": "4k",
  "quality": "high",
  "n": 1
}
Imagem para imagem (fusão de múltiplas referências)
{
  "model": "gpt-image-2-official",
  "prompt": "Fuse the two reference images into a single illustration poster, preserving the main silhouettes",
  "size": "1:1",
  "quality": "high",
  "image_urls": [
    "https://your-cdn.com/input-a.png",
    "https://your-cdn.com/input-b.png"
  ]
}
Inpainting (máscara)
{
  "model": "gpt-image-2-official",
  "prompt": "Replace the background with a desert sunset",
  "size": "1:1",
  "quality": "medium",
  "image_urls": ["https://your-cdn.com/photo.png"],
  "mask_url": "https://your-cdn.com/mask.png"
}
Múltiplas imagens (n > 1)
{
  "model": "gpt-image-2-official",
  "prompt": "Four minimalist poster variations of a red fox",
  "size": "1:1",
  "quality": "low",
  "n": 4
}
String de pixels direta (avançado)
{
  "model": "gpt-image-2-official",
  "prompt": "wide cinematic shot",
  "size": "3840x2160",
  "quality": "high"
}

Response

code
integer
Código de status da resposta
data
array
Array de dados da resposta

Consulta de resultados da tarefa

Após o envio bem-sucedido, um task_id é retornado. Consulte o status da tarefa via GET /v1/tasks/{task_id}, veja API de consulta de tarefas para mais detalhes.

Exemplo de resposta de sucesso

{
  "code": 200,
  "data": {
    "id": "task_01KPTXXXXXXXXXXXXXXX",
    "status": "completed",
    "progress": 100,
    "actual_time": 46,
    "cost": 0.05279,
    "result": {
      "images": [
        {
          "url": [
            "https://upload.apimart.ai/f/image/xxxxxxxx-gpt_image_2_official_task_xxx_0.png"
          ],
          "expires_at": 1776928569
        }
      ]
    }
  }
}
Fluxo de status da tarefa: submittedin_progresscompleted / failed. Acesso à imagem: data.result.images[0].url[0].

Recomendações de polling

  • Atraso da consulta inicial: Aguarde 10~20 segundos após o envio antes da primeira consulta
  • Intervalo de consulta: 3~5 segundos recomendados
  • Referência de timeout: Combinações high + 2k/4k podem levar até 130 segundos; timeout do cliente ≥ 180 segundos recomendado
  • Consulta em lote: Para consultar várias tarefas de uma só vez, use POST /v1/tasks/batch