Saltar para o conteúdo principal
POST
/
v1
/
jobs
Tarefas assíncronas
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"
}

​
Primeiros passos

​
URL base

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

​
Criar uma tarefa

Coloque na fila uma captura de ecrã assíncrona com o mesmo payload ScreenshotRequest usado pelo endpoint síncrono.

​
Exemplo de pedido

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
  }'
Um pedido bem-sucedido devolve um identificador de tarefa: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Parâmetros de criação de tarefa

​
request
Object
obrigatório
Um objeto ScreenshotRequest com os mesmos campos do endpoint síncrono de captura de ecrã (url, render, actions, cookies, etc.).
​
priority
Integer
Prioridade da tarefa. Valores mais altos são processados primeiro. Predefinição: 0.

​
Obter o estado da tarefa

Consulte uma tarefa por ID para verificar o estado e obter resultados após conclusão.

​
URL base

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

​
Exemplo de pedido

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Enquanto a tarefa está em execução: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
Quando a tarefa conclui com sucesso: 
{
  "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 da tarefa

EstadoDescrição
queuedA tarefa aguarda na fila.
runningA sessão do navegador está ativa.
doneCaptura concluída; result contém a saída.
failedCaptura falhou; error contém uma descrição.

​
Parâmetros de resposta

​
job_id
String
Identificador único da tarefa assíncrona.
​
status
String
Estado atual da tarefa: queued, running, done ou failed.
​
result
Object
O objeto de resultado da captura (mesma estrutura que a resposta do endpoint síncrono). Presente quando status é done.
​
error
String
Mensagem de erro. Presente quando status é failed.
​
meta
Object
Metadados adicionais sobre a execução da tarefa.