Jobs

Queue-backed job creation, status lookup, metrics, streaming reconnect, and cancellation.

by @saifyxpro

Base path: /api/jobs/*

Endpoints

MethodPathPurposeNotes
GET/api/jobslist queue jobsfiltered via query params
GET/api/jobs/metricsread queue metricsBullMQ-backed
POST/api/jobscreate generic queue jobsupports multiple job types
POST/api/jobs/scrapeenqueue scrape jobasync
POST/api/jobs/crawlenqueue crawl jobasync
POST/api/jobs/extractenqueue extract jobasync
POST/api/jobs/indexenqueue index jobasync
GET/api/jobs/activeread currently active jobchecks stream jobs first, then queue
GET/api/jobs/:idread job status or resultworks for stream and queue jobs
GET/api/jobs/:id/streamreconnect to job progress streamSSE
POST/api/jobs/:id/cancelcancel running or queued jobqueue or stream cancellation

Requirements

Queue-backed job flows require:

  • Redis
  • the worker process

When to use jobs

Use jobs when:

  • the work is asynchronous
  • you need cancellation
  • you need reconnectable status
  • the task can outlive a single request