Generar Efecto V1

Propósito

Genera un resultado con estilo de efecto de forma asíncrona. Puedes proporcionar una descripción de texto y, opcionalmente, subir una imagen para guiar la generación del efecto.

Método y Ruta

POST /public/v1/generate/effect/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
description	string	Sí	Descripción de texto del efecto a generar
resolution	string	Sí	Resolución de salida. Valores permitidos: 1K, 2K, 4K
image	file	No	Archivo de imagen de referencia opcional para guiar el efecto generado

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 Obtener Estado del Trabajo

Reglas de Error / Validación

Situación	Estado HTTP	Mensaje de Error
Invalid image file	400	"Invalid image file"
Clave de API inválida	401	Invalid API key

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/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (con imagen):

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