Generar efectos V2

Propósito

Genera de forma asíncrona una hoja de sprites de efecto a partir de una descripción de texto con un número de fotogramas elegido. Opcionalmente puedes subir una imagen de referencia y elegir el color de fondo de la hoja. Es la misma función que la pestaña V2 de la página "Generar efectos" de la aplicación web (la pestaña por defecto).

Costo en créditos: 3

Método y Ruta

POST /public/v1/generate/effect/v2

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	Descripción
description	string	Sí	Descripción del efecto. Se eliminan los espacios en blanco al inicio y al final
frame	integer	Sí	Fotogramas. Valores permitidos: 4, 9, 16
background_color	string	Sí	Color de fondo de la hoja. Valores permitidos: white, chroma_green, magenta, light_gray, light_purple, dark_gray
image	file	No	Imagen de referencia opcional (PNG o JPEG)

Consulta Generar efectos V1 para la tabla de colores de fondo.

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 4, 9, 16"
Clave de API inválida	401	"Invalid API key"
Campo faltante o valor de enumeración desconocido	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 efecto 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

Flujo de Estado: Pending → Succeed o Failed

Ejemplo de Solicitud

cURL (sin imagen):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "frame=9" \
-F "background_color=white"

cURL (con imagen):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "frame=16" \
-F "background_color=magenta" \
-F "image=@/path/to/input.png"