Crear Sprite V1

Propósito

Genera animaciones de sprite basadas en la imagen subida. Puedes crear hojas de sprite en estilo pixel art o estilo general.

Método y Ruta

POST /public/v1/sprite/make-sprite/v1

Autenticación

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

Encabezados Requeridos:

Authorization: Bearer {your_api_key}

Campos de Solicitud

Nombre del Campo	Tipo	Requerido	Descripción
image	file	Sí	Archivo de imagen que servirá como base para la generación del sprite
text	string	Sí	Prompt de texto para la generación del sprite
frame	integer	Sí	Número de frames a generar. Debe ser uno de: 25, 36, 49, 64, 81, 100, 121, 144, 169
is_pixel	boolean	Sí	Si la imagen es estilo pixel art. true o false

Respuesta

Respuesta Exitosa (200 OK):

{
  "job_id": "uuid-string"
}

Campo	Tipo	Descripción
job_id	string	Identificador único del trabajo creado. Consulta los resultados con Get Job Status

Reglas de Error / Validación

Situación	Estado HTTP	Mensaje de Error
Invalid image file	400	"Invalid image file"
Valor de frame no permitido	400	"frame should be one of 25, 36, 49, 64, 81, 100, 121, 144, 169"
Fallo de autenticación	401	Clave de API inválida

Valores de Frame Permitidos:

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

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 (GIF e imágenes de frames individuales)

Flujo de Estado: Pending → Succeed o Failed

Ejemplo de Solicitud

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 general):

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"