Endpoints
Get job schemas
GET /jobs/schemas
Returns all available job types with their full config schemas and field descriptions.
Example request:
Example response:
Create a job
POST /jobs
Request body:
Use
GET /jobs/schemas to retrieve the full config schema for a job type before creating a job.
Example response:
List jobs
GET /jobs
Query parameters:
Example request:
{"items": [...], "count": N} where each item is a job object with the same fields as the create response.
Get a job
GET /jobs/{job_id}
Example request:
Get latest run
GET /jobs/{job_id}/latest-run
Example request:
Update a job
PATCH /jobs/{job_id}
All fields are optional.
Example request:
Delete a job
DELETE /jobs/{job_id}
Soft-deletes a job.
Example request:
Trigger a job run
POST /job-runs
Request body:
Example request:
Job run status values:
Example response:
Get a job run
GET /job-runs/{job_run_id}
Example request:
status reaches completed, failed, or cancelled.
List job runs
GET /job-runs
Query parameters:
Example request:
{"items": [...], "count": N} where each item is a job run object with the same fields as the trigger response.
Cancel a job run
POST /job-runs/{job_run_id}/cancel
Example request:
Example response:

