Sprite Lite
Propósito
Genera una animación de sprite a partir de una imagen subida. Es la misma función que la pestaña Lite 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: 5 (25 fotogramas), 7 (36), 9 (49), 11 (64), 13 (81)
Método y Ruta
POST /public/v1/sprite/lite
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 Campo | Tipo | Requerido | Por defecto | Descripción |
|---|---|---|---|---|
| image | file | Sí | Imagen base para el sprite (PNG o JPEG) | |
| text | string | Sí | Prompt que describe el movimiento. Se eliminan los espacios en blanco y el texto no debe estar vacío | |
| frame | integer | Sí | Fotogramas. Valores permitidos: 25, 36, 49, 64, 81 | |
| is_pixel | boolean | No | false | Pixel art. Activa esta opción si la imagen adjunta está basada en pixel art |
| is_prompt_enhancement | boolean | No | true | Mejora del prompt. Refina lo que escribes para que sea más adecuado para generar sprites |
Créditos por frame
| frame | Créditos |
|---|---|
| 25 | 5 |
| 36 | 7 |
| 49 | 9 |
| 64 | 11 |
| 81 | 13 |
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 |
|---|---|---|
| La imagen no es un archivo PNG o JPEG válido | 400 | "Invalid image file" |
| Valor de frame no permitido | 400 | "frame should be one of 25, 36, 49, 64, 81" |
| text está vacío | 400 | "text must not be empty" |
| Clave de API inválida | 401 | "Invalid API key" |
| Campo faltante | 422 | Error 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:
- Guarda el
job_idrecibido en la respuesta - Haz polling a
GET /public/v1/job/{job_id}para verificar el estado - Cuando el estado sea
Succeed, consulta los resultados enimage_urls(hoja de sprites y GIF)
Flujo de Estado: Pending → Succeed o Failed
Ejemplo de Solicitud
cURL (pixel art):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/lite" \
-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, mejora del prompt desactivada):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/lite" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png" \
-F "text=running animation cycle" \
-F "frame=36" \
-F "is_prompt_enhancement=false"