Skip to main content
POST
Create Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload to create a new job.

extract_template_name
string
required

Name of the extract template to run.

name
string
required

Job name.

description
string | null

Free-text description of the job.

destination
JobDestinationPublicV2 · object | null

Where the job writes its results.

display_name
string | null

Human-friendly job name shown in the UI.

inputs
JobInputsPublicV2 · object | null

Input data configuration for the job.

schedule
JobSchedulePublicV2 · object | null

Cron schedule controlling automatic runs.

Response

Successful Response

A configured job: an agent plus its schedule, inputs, and destination.

id
string
required

Unique job identifier (job_).

Pattern: ^job_[1-9][0-9]*$
name
string
required

Job name.

created_at
string<date-time> | null

When the job was created.

description
string | null

Free-text description of the job.

destination
JobDestinationPublicV2 · object | null

Where the job writes its results.

display_name
string | null

Human-friendly job name shown in the UI.

extract_template_name
string | null

Name of the extract template this job runs.

inputs
JobInputsPublicV2 · object | null

Input data configuration for the job.

last_run_at
string<date-time> | null

Timestamp of the most recent run.

last_run_status
enum<string> | null

Status of the most recent run.

Available options:
PENDING,
RUNNING,
SUCCESS,
FAILED,
CANCELLED,
TIMEOUT,
WARNING
schedule
JobSchedulePublicV2 · object | null

Cron schedule controlling automatic runs.

updated_at
string<date-time> | null

When the job was last updated.