Skip to main content
POST
Create a scheduled agentic automation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agent_id
string
required

The ID of the agent this automation runs.

name
string
required

Human-readable name for the automation.

Maximum string length: 255
cron
string
required

Five-field cron expression (minute hour day month day-of-week) controlling when the automation fires. Seconds are not supported. The schedule must fire at most once every 15 minutes.

Maximum string length: 255
Example:

"0 9 * * 1"

description
string | null

Optional free-text description of what this automation does.

Maximum string length: 1000
enabled
boolean | null

Whether the automation should be active immediately after creation. Defaults to true when omitted or null.

timezone
string | null

IANA timezone identifier in which cron is interpreted. Defaults to "UTC" when omitted.

Maximum string length: 64
Example:

"America/New_York"

Response

Created automation

object
enum<string>
required

The object type, always 'agentic_automation'.

Available options:
agentic_automation
id
string
required

Unique identifier for the automation.

kind
enum<string>
required

What the automation is. scheduled for this route.

Available options:
scheduled
agent_id
string
required

The ID of the agent this automation runs.

name
string
required

Human-readable name of the automation.

description
string | null
required

Free-text description of what this automation does.

enabled
boolean
required

Whether the automation is active. When false the schedule is paused.

output_channel_type
string | null
required

Additional delivery transport, when one is stored. Not set by this route.

output_channel_id
string | null
required

Additional delivery address, when one is stored. Not set by this route.

creator_user_id
string
required

The user who created the automation.

last_updated_by_id
string
required

The user who last updated the automation.

created_at
string<date-time>
required

ISO 8601 timestamp of when the automation was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of the last modification.

last_run_at
string<date-time> | null
required

ISO 8601 timestamp of the latest run. Null until a run exists.

scheduled
object
required
app_event
object | null
required

App-event fields. Null for a scheduled automation.