Reskin de Sprite V1
Propósito
Cambia la apariencia de una imagen de sprite existente para crear un nuevo estilo de sprite. Se utiliza al cambiar la apariencia de un personaje o convertir a un estilo diferente.
Método y Ruta
POST /public/v1/sprite/reskin/v1
Autenticación
Consulta la página de Autenticación. Se requiere un token Bearer.
Encabezados Requeridos:
Authorization: Bearer {your_api_key}
Campos de la Solicitud
| Nombre del Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| image | file | Sí | Archivo de imagen del sprite original para hacer reskin |
| description | string | Sí | Descripción de los cambios que se aplicarán al sprite |
| resolution | string | Sí | Resolución de salida. Valores posibles: 1K, 2K, 4K |
| style | string | No | Especificación de estilo. Valores posibles: pixel, cartoon, sd, quater_view |
Respuesta
Respuesta Exitosa (200 OK):
{
"job_id": "uuid-string"
}
| Campo | Tipo | Descripción |
|---|---|---|
| job_id | string | Identificador único del trabajo creado. Consulta los resultados usando Get Job Status |
Reglas de Error / Validación
| Situación | Estado HTTP | Descripción |
|---|---|---|
| Invalid image file | 400 | "Invalid image file" |
| Valor de resolution inválido | 422 | Valores distintos a 1K, 2K, 4K resultarán en error de validación |
| Valor de style inválido | 422 | Valores distintos a pixel, cartoon, sd, quater_view resultarán en error de validación |
| Fallo de autenticación | 401 | API key inválida |
Opciones de Estilo:
pixel: Estilo pixel artcartoon: Estilo cartoonsd: Estilo SD (Standard Definition)quater_view: Estilo quarter view (isométrico)
Comportamiento del Trabajo Asíncrono
Este endpoint crea un trabajo asíncrono. Devuelve inmediatamente un job_id, y el trabajo real de reskin se ejecuta 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, verifica los resultados enimage_urls
Flujo de Estados: Pending → Succeed o Failed
Ejemplo de Solicitud
cURL (estilo predeterminado):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/reskin/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/sprite.png" \
-F "description=change the warrior character armor to golden" \
-F "resolution=2K"
cURL (estilo pixel especificado):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/reskin/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/sprite.png" \
-F "description=convert the character to pixel art style" \
-F "resolution=1K" \
-F "style=pixel"