Gerar efeitos V2

Propósito

Gera de forma assíncrona uma sprite sheet de efeito a partir de uma descrição em texto, com a quantidade de quadros escolhida. Opcionalmente, você pode enviar uma imagem de referência e escolher a cor de fundo da sheet. É o mesmo recurso da aba V2 da página "Gerar efeitos" do web app (a aba padrão).

Custo em créditos: 3

Método e Caminho

POST /public/v1/generate/effect/v2

Autenticação

Consulte a página de Autenticação. É necessário um token Bearer.

Cabeçalhos Obrigatórios:

Authorization: Bearer {your_api_key}

Campos da Requisição

Envie a requisição como multipart/form-data.

Nome do Campo	Tipo	Obrigatório	Descrição
description	string	Sim	Descrição do efeito. Espaços em branco no início e no fim são removidos
frame	integer	Sim	Quadros. Valores permitidos: 4, 9, 16
background_color	string	Sim	Cor de fundo da sheet. Valores permitidos: white, chroma_green, magenta, light_gray, light_purple, dark_gray
image	file	Não	Imagem de referência opcional (PNG ou JPEG)

Consulte Gerar efeitos V1 para a tabela de cores de fundo.

Resposta

Resposta de Sucesso (200 OK):

{
  "job_id": "uuid-string"
}

Campo	Tipo	Descrição
job_id	string	Identificador único do job criado. Use Obter Status do Job para consultar os resultados

Regras de Erro / Validação

Situação	Status HTTP	Mensagem de Erro
A imagem não é um arquivo PNG ou JPEG válido	400	"Invalid image file"
O valor de frame não é permitido	400	"frame should be one of 4, 9, 16"
Chave de API inválida	401	"Invalid API key"
Campo ausente ou valor de enum desconhecido	422	Erro de validação

Comportamento do Job Assíncrono

Este endpoint cria um job assíncrono. Ele retorna imediatamente um job_id, e a geração real do efeito ocorre em segundo plano.

Método de Polling:

1. Salve o job_id recebido na resposta
2. Faça polling em GET /public/v1/job/{job_id} para verificar o status
3. Quando o status se tornar Succeed, verifique os resultados em image_urls

Fluxo de Status: Pending → Succeed ou Failed

Exemplo de Requisição

cURL (sem imagem):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "frame=9" \
-F "background_color=white"

cURL (com imagem):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "frame=16" \
-F "background_color=magenta" \
-F "image=@/path/to/input.png"