Ir para o conteúdo principal

Sprite Plus

Propósito​

Gera uma animação de sprite a partir de um quadro inicial e de um quadro final opcional. É o mesmo recurso da aba Plus da página "Gerar sprites" do web app (Sprite Lite & Plus). Escolha o número de quadros com frame, exatamente como mostrado no controle deslizante da página web.

Custo em créditos: 9 (49 quadros), 13 (81 quadros)

Método e Caminho​

POST /public/v1/sprite/plus

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 CampoTipoObrigatórioPadrãoDescrição
start_imagefileSimQuadro inicial (PNG ou JPEG)
end_imagefileNãoQuadro final (opcional) (PNG ou JPEG)
textstringSimPrompt descrevendo o movimento. Espaços em branco são removidos e o texto não pode estar vazio
frameintegerSimQuadros. Valores permitidos: 49, 81
is_pixelbooleanNãofalsePixel art. Ative esta opção se a imagem anexada for baseada em pixel art
is_prompt_enhancementbooleanNãotrueAprimoramento do prompt. Refina o que você escreveu para ficar mais adequado à geração de sprites

Créditos por frame

frameCréditos
499
8113

Resposta​

Resposta de Sucesso (200 OK):

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

Regras de Erro / Validação​

SituaçãoStatus HTTPMensagem de Erro
Uma das imagens não é um arquivo PNG ou JPEG válido400"Invalid image file"
O valor de frame não é permitido400"frame should be one of 49, 81"
text está vazio400"text must not be empty"
Chave de API inválida401"Invalid API key"
Campo ausente422Erro 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 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 (sprite sheet e GIF)

Fluxo de Status: Pending → Succeed ou Failed

Exemplo de Requisição​

cURL (apenas quadro inicial):

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

cURL (quadro inicial + quadro final):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/plus" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "start_image=@/path/to/character_start.png" \
-F "end_image=@/path/to/character_end.png" \
-F "text=running animation cycle" \
-F "frame=81"