Ir para o conteúdo principal

Criar Sprite V1

Propósito

Gera animações de sprite com base na imagem enviada. Você pode criar folhas de sprite em estilo pixel art ou estilo regular.

Método e Caminho

POST /public/v1/sprite/make-sprite/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 Solicitação

Nome do CampoTipoObrigatórioDescrição
imagefileSimArquivo de imagem que servirá como base para a geração do sprite
textstringSimPrompt de texto para a geração do sprite
frameintegerSimNúmero de frames a gerar. Deve ser um de: 25, 36, 49, 64, 81, 100, 121, 144, 169
is_pixelbooleanSimSe a imagem é em estilo pixel art. true ou false

Resposta

Resposta de Sucesso (200 OK):

{
"job_id": "uuid-string"
}
CampoTipoDescrição
job_idstringIdentificador único do trabalho criado. Use Get Job Status para consultar os resultados

Regras de Erro / Validação

SituaçãoStatus HTTPMensagem de Erro
Invalid image file400"Invalid image file"
Valor de frame não permitido400"frame should be one of 25, 36, 49, 64, 81, 100, 121, 144, 169"
Falha na autenticação401Chave de API inválida

Valores de Frame Permitidos:

  • 25, 36, 49, 64, 81, 100, 121, 144, 169

Comportamento de Job Assíncrono

Este endpoint cria um job assíncrono. Ele retorna imediatamente um job_id, e a geração real do sprite 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 (GIF e imagens de frames individuais)

Fluxo de Status: PendingSucceed ou Failed

Exemplo de Solicitação

cURL (estilo pixel art):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/make-sprite/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png" \
-F "text=walking animation" \
-F "frame=64" \
-F "is_pixel=true"

cURL (estilo regular):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/make-sprite/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png" \
-F "text=running animation cycle" \
-F "frame=36" \
-F "is_pixel=false"