Saltar al contenido principal

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 CampoTipoRequeridoDescripción
imagefileArchivo de imagen del sprite original para hacer reskin
descriptionstringDescripción de los cambios que se aplicarán al sprite
resolutionstringResolución de salida. Valores posibles: 1K, 2K, 4K
stylestringNoEspecificación de estilo. Valores posibles: pixel, cartoon, sd, quater_view

Respuesta

Respuesta Exitosa (200 OK):

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

Reglas de Error / Validación

SituaciónEstado HTTPDescripción
Invalid image file400"Invalid image file"
Valor de resolution inválido422Valores distintos a 1K, 2K, 4K resultarán en error de validación
Valor de style inválido422Valores distintos a pixel, cartoon, sd, quater_view resultarán en error de validación
Fallo de autenticación401API key inválida

Opciones de Estilo:

  • pixel: Estilo pixel art
  • cartoon: Estilo cartoon
  • sd: 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:

  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, verifica los resultados en image_urls

Flujo de Estados: PendingSucceed 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"