Skip to main content

Which Endpoints Create Jobs

These endpoints create async jobs:
  • POST /live-monitor
  • POST /live-digest
Track jobs with:
  • GET /jobs
  • GET /jobs/{job_id}
  • DELETE /jobs/{job_id}

Lifecycle States

StatusMeaning
pendingJob accepted, not yet running
runningJob actively processing
completedJob finished successfully
stoppedJob stopped without failure (cancelled, timed out, or ended)
failedJob ended due to processing/runtime error

Typical Lifecycle

  1. Create job (live-monitor or live-digest)
  2. Receive job_id
  3. Observe running
  4. Reach terminal state: completed, stopped, or failed

Common Stop Reasons

You can inspect stop context in Get Job Details. Common reasons include:
  • condition detected (completed)
  • max duration reached (stopped)
  • max windows reached for digest (stopped)
  • manual cancellation via DELETE /jobs/{job_id} (stopped)
  • stream or processing failure (failed)

Time-Bounded Runs

Monitoring jobs are time-bounded. Design your workflow to start a follow-up job when terminal state is reached if continuous coverage is required.

Operational Pattern

  1. Create job
  2. Store job_id
  3. Track status (polling, webhook, or SSE)
  4. Handle terminal state
  5. Recreate job if coverage must continue

Next Steps