GET /job/{job_id}
Propósito
Este endpoint recupera el estado actual y los resultados de un trabajo asíncrono. Puedes verificar el estado de trabajos como generación de imágenes, upscaling, inpainting, separación de capas, etc., a través del ID del trabajo (job_id).
Método y Ruta
- HTTP Method:
GET - Path:
/public/v1/job/{job_id}
Autenticación
Este endpoint requiere autenticación Bearer Token. Consulta la guía de autenticación para más detalles.
Encabezados Requeridos:
Authorization: Bearer {your_api_key}
Campos de Solicitud
Parámetros de Ruta
| Nombre del Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
job_id | UUID | Requerido | Identificador único del trabajo a consultar (formato UUID) |
Respuesta
GetJobStatusResponse
| Nombre del Campo | Tipo | Descripción |
|---|---|---|
job_id | UUID | Identificador único del trabajo |
status | string | Estado del trabajo. Valores posibles: Pending, Succeed, Failed |
image_urls | list[string] | Lista de URLs de imágenes completadas. Solo se incluye cuando el trabajo tiene éxito |
Valores de Estado
- Pending: El trabajo está en progreso o en cola
- Succeed: El trabajo se completó exitosamente
- Failed: Ocurrió un error durante el procesamiento del trabajo
Reglas de Error / Validación
| Código HTTP | Situación de Error | Descripción |
|---|---|---|
401 Unauthorized | Fallo de autenticación | Clave de API inválida o encabezado de autenticación faltante |
404 Not Found | Trabajo no encontrado | No se puede encontrar un trabajo con el job_id proporcionado |
422 Unprocessable Entity | Formato de job_id inválido | job_id debe ser un UUID válido |
Comportamiento de Trabajos Asíncronos
Este endpoint se utiliza para consultar el estado de trabajos asíncronos. Los endpoints de creación de trabajos (por ejemplo, /image-tune/upscale) devuelven inmediatamente un job_id, y el procesamiento real ocurre en segundo plano.
Estrategia de Polling:
- Recibe el
job_iddespués de crear un trabajo y haz polling a este endpoint para verificar el estado - El estado inicial es
Pending - Cuando el trabajo se completa,
statuscambia aSucceedyimage_urlscontiene las URLs de las imágenes resultantes - Si el trabajo falla,
statuscambia aFailed - Se recomienda un intervalo de polling de 1-2 segundos
Ejemplo de Solicitud
cURL
curl -X GET "https://api.aetherforgeai.com/public/v1/job/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
Ejemplo de Respuesta (Éxito - Pending)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Pending",
"image_urls": []
}
Ejemplo de Respuesta (Éxito - Completado)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Succeed",
"image_urls": ["https://cdn.aetherforgeai.com/images/generated_abc123.png"]
}
Ejemplo de Respuesta (Fallido)
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "Failed",
"image_urls": []
}