Saltar al contenido principal
POST
/
v1
/
jobs
Trabajos asíncronos
curl --request POST \
  --url https://screenshot.cleariflow.com/v1/jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {},
  "priority": 123
}
'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Primeros pasos

​
URL base

https://screenshot.cleariflow.com/v1/jobs

​
Crear un trabajo

Encole una captura de pantalla asíncrona con la misma carga útil ScreenshotRequest que usa el endpoint síncrono.

​
Ejemplo de solicitud

curl -X POST 'https://screenshot.cleariflow.com/v1/jobs' \
  -H 'Content-Type: application/json' \
  -d '{
    "request": {
      "api_key": "YOUR_UNIQUE_API_KEY",
      "url": "https://cleariflow.com"
    },
    "priority": 10
  }'
Una solicitud exitosa devuelve un identificador de trabajo: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Parámetros de creación de trabajo

​
request
Object
requerido
Un objeto ScreenshotRequest con los mismos campos que el endpoint síncrono de captura de pantalla (url, render, actions, cookies, etc.).
​
priority
Integer
Prioridad del trabajo. Los valores más altos se procesan primero. Por defecto: 0.

​
Obtener el estado del trabajo

Consulte un trabajo por ID para verificar su estado y recuperar resultados al completarse.

​
URL base

https://screenshot.cleariflow.com/v1/jobs/{job_id}

​
Ejemplo de solicitud

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Mientras el trabajo está en ejecución: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Cuando el trabajo se completa correctamente: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
Valores de estado del trabajo

EstadoDescripción
queuedEl trabajo espera en la cola.
runningLa sesión del navegador está activa.
doneCaptura completada; result contiene la salida.
failedCaptura fallida; error contiene una descripción.

​
Parámetros de respuesta

​
job_id
String
Identificador único del trabajo asíncrono.
​
status
String
Estado actual del trabajo: queued, running, done o failed.
​
result
Object
El objeto de resultado de la captura (misma estructura que la respuesta del endpoint síncrono). Presente cuando status es done.
​
error
String
Mensaje de error. Presente cuando status es failed.
​
meta
Object
Metadatos adicionales sobre la ejecución del trabajo.