Back to API List
Background Jobs API
System
4 Endpoints
Queue and monitor long-running background tasks with progress tracking and retry logic.
Internal API - Hosted by this App
API Endpoints & Usage
Explore and interact with the available endpoints for the Background Jobs API. These API routes are live!
POST
/api/jobs
Queue new background job with parameters.
Try it out
GET
/api/jobs/{jobId}
Get job status, progress, and results. Replace {jobId} with an actual ID.
Try it out
Replace placeholders (e.g., {userId}) with actual values in the path above. You can also add/edit query parameters (e.g., ?key=value).
GET
/api/jobs
List jobs with status filtering and pagination.
Try it out
You can add or change query parameters in the path above (e.g., ?name=User).
DELETE
/api/jobs/{jobId}
Cancel queued or running job. Replace {jobId} with an actual ID.
Try it out
Replace placeholders (e.g., {userId}) with actual values in the path above.