List jobs

Warning

This method is only available to users who have signed up on the Tanaos platform and generated an API Key. If you are using Synthex without an API Key, this method will return an authentication error.

Retrieves all jobs that have been executed by the user whose API key is used to authenticate the request. Both jobs generated through Synthex and those generated on the Tanaos platform are included.

Arguments

---

• limit
  int
  optional
  
  The maximum number of jobs to retrieve. If not specified, the default value is 10.
• offset
  int
  optional
  
  The number of jobs to skip before starting to collect the result set. If not specified, the default value is 0.

Response

---

• total
  int
  
  The total number of jobs that have been executed by the user.
• jobs
  list[JobResponseModel]
  
  A list of jobs that have been executed by the user. Each job is represented as a JobResponseModel object with the following fields:
  • id
    str
    
    The job's unique identifier.
  • name
    str
    
    The name of the job.
  • description
    str
    
    The description of the job.
  • datapoint_num
    int
    
    The number of datapoints in the job.
  • output_domain
    str
    
    A longer job description, which specifies the kind of job, constraints to its values and other characteristics.
  • status
    JobStatus
    
    An object indicating the job status. Possible values are:
    • JobStatus.ON_HOLD: the job is on hold and waiting for user action. This can only occur for jobs generated on the Tanaos platform.
    • JobStatus.IN_PROGRESS: the job is currently being executed.
    • JobStatus.COMPLETED: the job has been successfully executed
    • JobStatus.FAILED: the job has failed.
  • created_at
    datetime
    
    The date and time when the job was created.

Python

from synthex import Synthex

client = Synthex()
jobs = client.jobs.list()

200 Response

{
    "total": 2,
    "jobs": [
        {
            "id": "dh8492904hnf",
            "name": "Sample job name 1",
            "description": "Sample job description 1",
            "datapoint_num": 10000,
            "output_domain": "Sample job domain 1",
            "status": "Completed",
            "created_at": datetime(2025, 4, 12, 19, 10, 32)
        },
        {
            "id": "ka9915dn6dhr",
            "name": "Sample job name 2",
            "description": "Sample job description 2",
            "datapoint_num": 8000,
            "output_domain": "Sample job domain 2",
            "status": "Completed",
            "created_at": datetime(2025, 4, 13, 12, 17, 18)
        }
    ]
}