Skip to main content
POST
Schedule create.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Display name of the schedule.

Example:

"Morning sync"

cron
string
required

5-field cron expression used by the scheduling system.

Example:

"30 9 * * MON-FRI"

targetType
enum<string>
required

Normalized execution target type used by runtime dispatch.

Available options:
JOB_TEMPLATE,
AGENT,
PLATFORM_OPERATION
Example:

"AGENT"

targetId
string
required

Execution target id aligned with targetType.

Example:

"eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee"

timezone
string
required

IANA timezone for this schedule. Use canonical names like Europe/Warsaw or UTC. Abbreviations like CET or EST are rejected because they break DST handling.

Example:

"Europe/Warsaw"

input
object

Runtime input for Job targets, exposed through api.input("templateInputs"). Defaults to {}. Override is shallow; Deep Override recursively merges objects. Automation keys take precedence; arrays and null replace whole values. Does not change the event message, Job execution policy, concurrency or retry settings.

Example:
inputMode
enum<string>
default:override

override: shallow overlay onto Job templateInputs; deep_override: recursively overlay objects, replacing arrays and retaining null as a value; automation keys win in both modes; replace: replace all Job templateInputs, including clearing them with {}. Defaults to override.

Available options:
override,
deep_override,
replace
Example:

"override"

category
string

Optional presentation category used to group schedules.

Example:

"Operations"

active
boolean

Whether the schedule is active immediately after creation.

Example:

true

desc
string

Operator-visible schedule description.

Example:

"Runs the customer sync every business morning."

metadata
object | null

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
targetVersion
number

Optional reserved target version metadata. Ignored for AGENT targets, which always execute the current Agent definition.

Example:

2

targetConfig
object

Optional target-specific execution settings.

Example:

Response

Job scheduled.

Last modified on September 5, 2026