Skip to main content
PATCH
/
runs
/
crons
/
{cron_id}
Update Cron
curl --request PATCH \
  --url https://api.example.com/runs/crons/{cron_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "input": {},
  "metadata": {},
  "config": {},
  "context": {},
  "webhook": "<string>",
  "interrupt_before": "<string>",
  "interrupt_after": "<string>",
  "multitask_strategy": "<string>",
  "enabled": true,
  "stream_mode": "<string>",
  "stream_subgraphs": true,
  "timezone": "<string>"
}
'
{
  "cron_id": "<string>",
  "assistant_id": "<string>",
  "schedule": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "thread_id": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "payload": {},
  "user_id": "<string>",
  "next_run_date": "2023-11-07T05:31:56Z",
  "metadata": {},
  "enabled": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.aegra.dev/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
cron_id
string
required

Body

application/json

Request body for updating an existing cron job.

​
schedule
string | null
Maximum string length: 256
​
end_time
string<date-time> | null
​
input
Input · object
​
metadata
Metadata · object
​
config
Config · object
​
context
Context · object
​
webhook
string | null
Maximum string length: 2048
​
interrupt_before
Allowed value: "*"
​
interrupt_after
Allowed value: "*"
​
on_run_completed
enum<string> | null
Available options:
delete,
keep
​
multitask_strategy
string | null
Maximum string length: 256
​
enabled
boolean | null
​
stream_mode
​
stream_subgraphs
boolean | null
​
timezone
string | null
Maximum string length: 64

Response

Successful Response

Response model matching the SDK Cron TypedDict.

​
cron_id
string
required
​
assistant_id
string
required
​
schedule
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
thread_id
string | null
​
on_run_completed
enum<string> | null
Available options:
delete,
keep
​
end_time
string<date-time> | null
​
payload
Payload · object
​
user_id
string | null
​
next_run_date
string<date-time> | null
​
metadata
Metadata · object
​
enabled
boolean
default:true