Passer au contenu principal
POST
/
v1
/
jobs
Jobs asynchrones
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"
}

​
Premiers pas

​
URL de base

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

​
Créer un job

Mettez en file d’attente une capture d’écran asynchrone avec la même charge utile ScreenshotRequest que l’endpoint synchrone.

​
Exemple de requête

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
  }'
Une requête réussie renvoie un identifiant de job : 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Paramètres de création de job

​
request
Object
requis
Un objet ScreenshotRequest avec les mêmes champs que l’endpoint synchrone de capture d’écran (url, render, actions, cookies, etc.).
​
priority
Integer
Priorité du job. Les valeurs plus élevées sont traitées en premier. Par défaut : 0.

​
Obtenir le statut d’un job

Interrogez un job par ID pour vérifier son statut et récupérer les résultats une fois terminé.

​
URL de base

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

​
Exemple de requête

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Pendant l’exécution du job : 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Lorsque le job se termine avec succès : 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
Valeurs de statut du job

StatutDescription
queuedLe job attend dans la file d’attente.
runningLa session de navigateur est active.
doneCapture terminée ; result contient la sortie.
failedCapture échouée ; error contient une description.

​
Paramètres de réponse

​
job_id
String
Identifiant unique du job asynchrone.
​
status
String
Statut actuel du job : queued, running, done ou failed.
​
result
Object
L’objet résultat de la capture (même structure que la réponse de l’endpoint synchrone). Présent lorsque status est done.
​
error
String
Message d’erreur. Présent lorsque status est failed.
​
meta
Object
Métadonnées supplémentaires sur l’exécution du job.