Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: CreateCronJobRequest

@kortexya/reasoninglayer

@kortexya/reasoninglayer / CreateCronJobRequest

Interface: CreateCronJobRequest

Section titled “Interface: CreateCronJobRequest”

Defined in: src/types/cron.ts:56

Body of POST /api/v1/cron/jobs — schedule a job for the caller’s tenant.

Properties

Section titled “Properties”

agentId

Section titled “agentId”

agentId: string

Defined in: src/types/cron.ts:69

UUID of the agent that handles the triggers.

backoffMs?

Section titled “backoffMs?”

optional backoffMs?: number | null

Defined in: src/types/cron.ts:88

Backoff in milliseconds between retries (engine default 1000).

description?

Section titled “description?”

optional description?: string | null

Defined in: src/types/cron.ts:60

Optional description.

enabled?

Section titled “enabled?”

optional enabled?: boolean | null

Defined in: src/types/cron.ts:79

Whether the job starts active (engine default true). false creates it paused, with no next fire time.

jitterMs?

Section titled “jitterMs?”

optional jitterMs?: number | null

Defined in: src/types/cron.ts:81

Reserved. Omit it or send 0: the engine refuses a nonzero jitter with 400.

maxRetries?

Section titled “maxRetries?”

optional maxRetries?: number | null

Defined in: src/types/cron.ts:86

Reserved. Automatic retries default to 0; the engine refuses a nonzero value with 400.

name

Section titled “name”

name: string

Defined in: src/types/cron.ts:58

Human-readable name for the job.

payload?

Section titled “payload?”

optional payload?: string | null

Defined in: src/types/cron.ts:71

Optional payload delivered with each trigger (a JSON document, as a string).

scheduleType

Section titled “scheduleType”

scheduleType: CronScheduleType

Defined in: src/types/cron.ts:62

The kind of schedule CreateCronJobRequest.scheduleValue holds.

scheduleValue

Section titled “scheduleValue”

scheduleValue: string

Defined in: src/types/cron.ts:67

Schedule value: a cron expression (cron), an RFC 3339 instant (oneshot), or an integer number of seconds (interval).

timezone?

Section titled “timezone?”

optional timezone?: string | null

Defined in: src/types/cron.ts:77

The schedule timezone. Defaults to UTC, and the engine’s scheduler supports only UTC: any other name, including a valid IANA zone, is refused with 400. A cron expression is read on the UTC clock.