RunResponse as manually triggered runs, so they work with all the same monitoring and audit tooling.
Common use cases
- Daily report generation (summarize overnight activity, generate executive briefings)
- Periodic data analysis (run analytics agents on a nightly or weekly cadence)
- Automated monitoring alerts (poll data sources and notify on anomalies)
- Batch knowledge base updates (re-ingest and refresh vector content on a schedule)
Creating a schedule
1
Define the schedule payload
Build a
ScheduleDTO with the agent to run, the message to send it, and the recurrence expression:2
Submit the schedule
201 Created with the new schedule including its assigned ID.Cron expression reference
Schedules use standard five-field cron syntax:Managing schedules
List all schedules (paginated):204 No Content on success.
Triggering a schedule manually
To execute a schedule immediately without waiting for its next cron time:Viewing run history
To see the execution history for a specific schedule:Scheduled runs execute as background jobs. If a scheduled run fails, the job status will show
FAILED and the failure reason will be captured in the run record. The schedule itself continues to execute on its defined cadence regardless of individual run outcomes.