Vai al contenuto principale
POST
/
v1
/
jobs
Job asincroni
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"
}

​
Per iniziare

​
URL base

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

​
Creare un job

Accoda uno screenshot asincrono con lo stesso payload ScreenshotRequest usato dall’endpoint sincrono.

​
Esempio di richiesta

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 richiesta riuscita restituisce un identificatore di job: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Parametri di creazione del job

​
request
Object
obbligatorio
Un oggetto ScreenshotRequest con gli stessi campi dell’endpoint screenshot sincrono (url, render, actions, cookies, ecc.).
​
priority
Integer
Priorità del job. Valori più alti vengono elaborati per primi. Predefinito: 0.

​
Ottenere lo stato del job

Interroga un job per ID per verificarne lo stato e recuperare i risultati al completamento.

​
URL base

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

​
Esempio di richiesta

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Mentre il job è in esecuzione: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Al completamento con successo: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
Valori di stato del job

StatoDescrizione
queuedIl job è in attesa in coda.
runningLa sessione del browser è attiva.
doneScreenshot completato; result contiene l’output.
failedScreenshot fallito; error contiene una descrizione.

​
Parametri di risposta

​
job_id
String
Identificatore univoco del job asincrono.
​
status
String
Stato attuale del job: queued, running, done o failed.
​
result
Object
L’oggetto risultato dello screenshot (stessa struttura della risposta dell’endpoint sincrono). Presente quando status è done.
​
error
String
Messaggio di errore. Presente quando status è failed.
​
meta
Object
Metadati aggiuntivi sull’esecuzione del job.