Jobs

Create a job

Create a job that runs a Python script on the platform.

The code becomes the job's script; declare its dependencies inline in a PEP 723 # /// script block. The job then appears on the platform, where it can be run and its executions reviewed. To change an existing job's name, description, or code, use update_job instead.

Requires an API key with the write scope.

post/api/v1/jobs

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/jobs
  • Auth: HTTP bearer

Request body

namestring required

Name of the job. Unique within the organization.

descriptionstring nullable

What the job does.

codestring required

Python source of the script the job runs. Declare dependencies inline in a PEP 723 # /// script block.

trigger_enabledboolean

True runs the job automatically when its trigger fires.

trigger_category'file_uploaded' | 'job_completed' | 'schedule'
trigger_instrument_idstring uuid nullable

Restricts a file_uploaded trigger to files from this instrument.

trigger_conditionsobject nullable

Filters on the triggering event. For file_uploaded, any of file_name_pattern, file_extensions (list of strings starting with '.'; files with no extension always pass), source_type, min_size_kb, and max_size_kb (both inclusive). file_name_pattern is a case-sensitive glob in which * matches any characters, including folder separators, ? matches one character, and '/' and '' each match either separator. It must match the file's whole path or the part after any separator, so '.csv' and 'run_.csv' match files in any folder. For job_completed, source_job_id (required) and statuses (list drawn from completed and failed; defaults to completed). For schedule, cron (required five-field expression: minute, hour, day of month, month, day of week) and timezone (required IANA timezone, e.g. America/Los_Angeles). Cron supports numbers, month and weekday names, *, ranges, lists, and steps.

Response

OK

idstring uuid required

Pass this as job_id to the job execution tools.

namestring required
descriptionstring nullable
archivedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.