Skip to main content

​
List Jobs

GET /jobs
Returns a list of jobs in the system.
​
start
integer
default:"0"
Starting job ID for pagination
​
limit
integer
default:"0"
Maximum number of jobs to return (0 for all)
​
ascending
boolean
default:"false"
Sort order by creation time
​
method
string
Filter by job method (e.g., “addBinarySample”, “query”)
​
state
string
Filter by job state (e.g., “finished”, “failed”, “processing”)
​
filter
string
Additional text filter for job data
​
status
string
Response status
​
data
array
Array of job objects
{
  "status": "successful",
  "data": [
    {
      "job_id": "507f1f77bcf86cd799439011",
      "method": "addBinarySample",
      "state": "finished",
      "created": "2024-01-15T10:30:00",
      "finished": "2024-01-15T10:31:00"
    }
  ]
}

​
Get Job Statistics

GET /jobs/stats
Returns statistics about jobs in the system.
​
with_refresh
boolean
default:"false"
Refresh statistics before returning
​
status
string
Response status
​
data
object
Statistics including counts by state and method
{
  "status": "successful",
  "data": {
    "total_jobs": 150,
    "finished": 140,
    "processing": 5,
    "failed": 5
  }
}

​
Get Job

GET /jobs/{job_id}
Returns information about a specific job.
​
job_id
string
required
Job ID (24 hexadecimal characters)
​
status
string
Response status
​
data
object
Job details including state, method, timestamps, and parameters
{
  "status": "successful",
  "data": {
    "job_id": "507f1f77bcf86cd799439011",
    "method": "addBinarySample",
    "state": "finished",
    "created": "2024-01-15T10:30:00",
    "finished": "2024-01-15T10:31:00",
    "parameters": {},
    "result_id": "507f191e810c19729de860ea"
  }
}

​
Delete Job

DELETE /jobs/{job_id}
Deletes a specific job from the system.
​
job_id
string
required
Job ID (24 hexadecimal characters)
​
status
string
Response status
​
data
object
Number of jobs deleted

​
Delete Multiple Jobs

DELETE /jobs
Deletes multiple jobs matching the specified criteria.
​
method
string
Filter by job method
​
created_before
string
Delete jobs created before this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)
​
finished_before
string
Delete jobs finished before this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)
​
status
string
Response status
​
data
object
Number of jobs deleted

​
Get Job Result

GET /jobs/{job_id}/result
Returns the result of a completed job.
​
job_id
string
required
Job ID (24 hexadecimal characters)
​
compact
boolean
default:"false"
Return compact results (excludes function-level matches for matching/query jobs)
​
status
string
Response status
​
data
object
Job result data (varies by job type)

​
Get Result

GET /results/{result_id}
Returns a result by its ID.
​
result_id
string
required
Result ID (24 hexadecimal characters)
​
compact
boolean
default:"false"
Return compact results
​
status
string
Response status
​
data
object
Result data

​
Get Job for Result

GET /results/{result_id}/job
Returns the job that produced a specific result.
​
result_id
string
required
Result ID (24 hexadecimal characters)
​
status
string
Response status
​
data
object
Job information

Build docs developers (and LLMs) love

Get started for freeTalk to us