Gerar Efeito V1

Propósito

Gera um resultado com estilo de efeito de forma assíncrona. Você pode fornecer uma descrição em texto e, opcionalmente, fazer upload de uma imagem para orientar a geração do efeito.

Método e Caminho

POST /public/v1/generate/effect/v1

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

Nome do Campo	Tipo	Obrigatório	Descrição
description	string	Sim	Descrição em texto do efeito a ser gerado
resolution	string	Sim	Resolução de saída. Valores permitidos: 1K, 2K, 4K
image	file	Não	Arquivo de imagem de referência opcional para orientar o efeito gerado

Resposta

Resposta de Sucesso (200 OK):

{
  "job_id": "uuid-string"
}

Campo	Tipo	Descrição
job_id	string	Identificador único do job criado. Consulte o resultado em Obter Status do Job

Regras de Erro / Validação

Situação	Status HTTP	Mensagem de Erro
Invalid image file	400	"Invalid image file"
Chave de API inválida	401	Invalid API key

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 for Succeed, verifique o resultado 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/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (com imagem):

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