Saltar al contenido principal

Generar Efecto V2

Propósito

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

Método y Ruta

POST /public/v1/generate/effect/v2

Autenticación

Consulta la página de Autenticación. Se requiere token Bearer.

Encabezados Requeridos:

Authorization: Bearer {your_api_key}

Campos de Solicitud

Nombre del CampoTipoRequeridoDescripción
descriptionstringDescripción del efecto a generar
qualitystringCalidad: standard, pro
framenumberCantidad de cuadros: 4, 9, 16
imagefileNoImagen de referencia opcional

Respuesta

Respuesta Exitosa (200 OK):

{
"job_id": "uuid-string"
}
CampoTipoDescripción
job_idstringIdentificador único del trabajo creado. Consulta los resultados con Obtener Estado del Trabajo

Reglas de Error / Validación

SituaciónEstado HTTPMensaje de Error
Invalid image file400"Invalid image file"
Clave de API inválida401Invalid 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: PendingSucceed 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 "quality=standard" \
-F "frame=4"

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 "quality=pro" \
-F "frame=16" \
-F "image=@/path/to/input.png"