Skip to main content
POST
Create Scheduled Task
Create a recurring scheduled task. The change takes effect immediately — the agent runs the given prompt on every cron match.

Request Body

string
required
Cron expression (5-field crontab, UTC). Example: 0 9 * * * runs daily at 09:00 UTC.
string
required
Instruction the agent runs on each fire.
string
Optional human-readable label for the task.
boolean
default:true
Create the task active (default) or paused.

Example Request

Example Response

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

agent_id
string
required

Body

application/json

Create a recurring scheduled task for an agent.

cron
string
required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

prompt
string
required

Instruction the agent runs on each fire.

title
string | null

Optional human-readable label.

enabled
boolean
default:true

Create the task active (default) or paused.

Response

Successful Response

A recurring scheduled task — the simplified view of one cron task source node.

id
string
required

Source-node id. Pass it to update/remove/run the task.

cron
string
required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

prompt
string
required

Instruction the agent runs on each fire.

title
string | null

Human-readable label for the task.

enabled
boolean
default:true

Whether the task is active. Disabled tasks keep their config but do not fire.