Passer au contenu principal
POST
/
v1
/
jobs
Async jobs
curl --request POST \
  --url https://scrape.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://scrape.cleariflow.com/v1/jobs

Créer une tâche

Mettez en file d’attente un scrape asynchrone avec la même charge ScrapeRequest que l’endpoint synchrone.

Exemple de requête

curl -X POST 'https://scrape.cleariflow.com/v1/jobs' \
  -H 'Content-Type: application/json' \
  -d '{
    "request": {
      "api_key": "YOUR_UNIQUE_API_KEY",
      "url": "https://example.com"
    },
    "priority": 10
  }'
Cette requête réussie renvoie un identifiant de tâche :
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Paramètres de création de tâche

request
Object
requis
Un objet ScrapeRequest avec les mêmes champs que l’endpoint de scraping synchrone (url, render, actions, cookies, etc.).
priority
Integer
Priorité de la tâche. Les valeurs plus élevées sont traitées en premier. Par défaut : 0.

Obtenir le statut d’une tâche

Interrogez une tâche par ID pour vérifier son statut et récupérer les résultats une fois terminée.

URL de base

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

Exemple de requête

curl 'https://scrape.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Pendant l’exécution de la tâche :
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Lorsque la tâche se termine avec succès :
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "html": "<!DOCTYPE html><html>...</html>",
    "meta": {
      "url": "https://example.com",
      "status_code": 200,
      "duration_ms": 8123
    }
  }
}

Valeurs de statut de tâche

StatutDescription
queuedLa tâche attend dans la file d’attente.
runningLa session du navigateur est active.
doneScraping terminé ; result contient la sortie.
failedScraping échoué ; error contient une description.

Paramètres de réponse

job_id
String
Identifiant unique de la tâche asynchrone.
status
String
Statut actuel de la tâche : queued, running, done ou failed.
result
Object
L’objet résultat du scraping (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 de la tâche.