Saltar al contenido principal

Sprite Plus

Propósito​

Genera una animación de sprite a partir de un fotograma inicial y un fotograma final opcional. Es la misma función que la pestaña Plus de la página "Generar sprites" de la aplicación web (Sprite Lite & Plus). Elige el número de fotogramas con frame, exactamente como se muestra en el control deslizante de la página web.

Costo en créditos: 9 (49 fotogramas), 13 (81 fotogramas)

Método y Ruta​

POST /public/v1/sprite/plus

Autenticación​

Consulta la página de autenticación. Se requiere un token Bearer.

Encabezados Requeridos:

Authorization: Bearer {your_api_key}

Campos de Solicitud​

Envía la solicitud como multipart/form-data.

Nombre del CampoTipoRequeridoPor defectoDescripción
start_imagefileSíFotograma inicial (PNG o JPEG)
end_imagefileNoFotograma final (opcional) (PNG o JPEG)
textstringSíPrompt que describe el movimiento. Se eliminan los espacios en blanco y el texto no debe estar vacío
frameintegerSíFotogramas. Valores permitidos: 49, 81
is_pixelbooleanNofalsePixel art. Activa esta opción si la imagen adjunta está basada en pixel art
is_prompt_enhancementbooleanNotrueMejora del prompt. Refina lo que escribes para que sea más adecuado para generar sprites

Créditos por frame

frameCréditos
499
8113

Respuesta​

Respuesta Exitosa (200 OK):

{
"job_id": "uuid-string"
}
CampoTipoDescripción
job_idstringIdentificador único del trabajo creado. Consulta los resultados con Get Job Status

Reglas de Error / Validación​

SituaciónEstado HTTPMensaje de Error
Alguna de las imágenes no es un archivo PNG o JPEG válido400"Invalid image file"
Valor de frame no permitido400"frame should be one of 49, 81"
text está vacío400"text must not be empty"
Clave de API inválida401"Invalid API key"
Campo faltante422Error de validación

Comportamiento de Trabajos Asíncronos​

Este endpoint crea un trabajo asíncrono. Devuelve inmediatamente un job_id, y la generación real del sprite ocurre en segundo plano.

Método de Polling:

  1. Guarda el job_id recibido en la respuesta
  2. Haz polling a GET /public/v1/job/{job_id} para verificar el estado
  3. Cuando el estado sea Succeed, consulta los resultados en image_urls (hoja de sprites y GIF)

Flujo de Estado: Pending → Succeed o Failed

Ejemplo de Solicitud​

cURL (solo fotograma 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 (fotograma inicial + 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"