Skip to main content
POST
Create schedule

Authorizations

Authorization
string
header
required

JWT authentication token

Body

application/json
task_message
string
required

The task message to execute

Minimum string length: 1
custom_weekdays
integer[]

For custom frequency - array of weekdays (0=Sunday, 6=Saturday)

Required range: 0 <= x <= 6
direct_agent_id
string
file_keys
string[]

Optional file references

llm_model
string

LLM model identifier. Values may be Neo model labels or provider-native model IDs discovered at runtime from an AI connection. "auto" defers model selection to the agent, which picks per-request based on task complexity, cost, and security context.

Minimum string length: 1
metadata
object

Optional metadata for delivery configuration (e.g., Slack channel info for posting results)

name
string

Human-readable schedule name

Maximum string length: 256
project_id
string<uuid>

Optional project ID to create a project-scoped schedule (requires project membership)

reporting_mode
enum<string>

Output reporting mode - 'full' (default) returns all data, 'changes_only' generates a diff report comparing current results with the previous execution

Available options:
full,
changes_only
run_at
string

For one_time schedules - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time

scan_frequency
enum<string>

Required for recurring schedules

Available options:
daily,
weekly,
monthly,
custom
schedule_type
enum<string>
default:recurring
Available options:
recurring,
one_time
secrets
string[]

Optional secret names to expose to each scheduled execution

selected_visibility_type
enum<string>
Available options:
private,
unlisted,
team
source_task_id
string

The source task/chat ID that this schedule was created from (if any)

start_time
string

Start time in HH:MM format (24h)

Response

Schedule created

schedule
object
required