Zum Hauptinhalt springen
POST
/
v1
/
jobs
Asynchrone Jobs
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"
}

​
Erste Schritte

​
Basis-URL

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

​
Job erstellen

Stellen Sie einen asynchronen Screenshot in die Warteschlange mit derselben ScreenshotRequest-Nutzlast wie beim synchronen Endpunkt.

​
Beispielanfrage

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
  }'
Eine erfolgreiche Anfrage liefert eine Job-ID: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Parameter zur Job-Erstellung

​
request
Object
erforderlich
Ein ScreenshotRequest-Objekt mit denselben Feldern wie der synchrone Screenshot-Endpunkt (url, render, actions, cookies usw.).
​
priority
Integer
Job-Priorität. Höhere Werte werden zuerst verarbeitet. Standard: 0.

​
Job-Status abrufen

Fragen Sie einen Job anhand der ID ab, um den Status zu prüfen und Ergebnisse nach Abschluss abzurufen.

​
Basis-URL

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

​
Beispielanfrage

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Während der Job läuft: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Bei erfolgreichem Abschluss: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
Job-Statuswerte

StatusBeschreibung
queuedJob wartet in der Warteschlange.
runningBrowser-Sitzung ist aktiv.
doneScreenshot abgeschlossen; result enthält die Ausgabe.
failedScreenshot fehlgeschlagen; error enthält eine Beschreibung.

​
Antwortparameter

​
job_id
String
Eindeutige Kennung für den asynchronen Job.
​
status
String
Aktueller Job-Status: queued, running, done oder failed.
​
result
Object
Das Screenshot-Ergebnisobjekt (gleiche Struktur wie die Antwort des synchronen Endpunkts). Vorhanden, wenn status done ist.
​
error
String
Fehlermeldung. Vorhanden, wenn status failed ist.
​
meta
Object
Zusätzliche Metadaten zur Job-Ausführung.