Jobs
Jobs are long-running tasks that are executed asynchronously. Jobs are identified by their job ID, in the form of job-1569583053767, which is returned when starting a job. Subsequent job updates are published over the websockets API.

Updates

There are two events that are published regarding jobs:
  • job-data-{jobId} - status update on the job, e.g. progress when training a neural network. Provides a single argument: { data: 'string with status' }.
  • job-finished-{jobId} - indicator that the job finished. Provides a single argument: { success: true } which indicates whether the job was executed successfully.

Canceling a job

You can also cancel a job through the websocket by sending a job-cancel event. Pass in one parameter (the job ID).
Export as PDF
Copy link