Skip to main content
PATCH
Edit, pause or resume a schedule

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

recurrenceSettingId
string
required
projectId
string<uuid>
required

Body

application/json
name
string

Unique within the project

Maximum string length: 100
Example:

"Weekly EU roundup"

cron
string

UTC hour-granular cron, or "every:Nh@HH:00[/YYYY-MM-DD]"

Example:

"0 6 * * *"

status
enum<string>

Active fires on schedule, paused does not

Available options:
active,
paused
llmProviders
string[]

Raw model names

Example:
executionCount
number

Runs per query per fire

Required range: 1 <= x <= 100
Example:

3

Response

id
string<uuid>
required

Identifies the schedule in the pause and resume route

name
string
required

Label the project gave the schedule, unique within it

cron
string
required

UTC cron

status
enum<string>
required

Active fires on the cron, paused never fires and reports no next run

Available options:
active,
paused
llmProviders
string[]
required

Raw model names

executionCount
number
required

Runs per query per fire

queriesCount
number
required

Queries attached to the schedule, each run on every fire

createdAt
string<date-time>
required

When the schedule was created, not when it last fired

nextRunAt
string<date-time>

Next fire time; absent when paused or none within 32 days