Skip to main content
POST
Create a schedule
Registers a schedule for your organization. The session_request template is validated and resolved at creation time (the agent must exist), then re-resolved on every fire. Returns 201 with the created schedule object.

Request body

name
string
required
Display name for the schedule (max 255 characters).
timing
object
required
When the schedule fires:
  • expression (string): Five-field cron expression, e.g. "0 9 * * 1-5".
  • timezone (string): IANA timezone the expression is evaluated in, e.g. "Europe/Paris".
  • type (string, optional): "cron", the default and only variant today.
The expression may not fire more often than once every 5 minutes.
session_request
object
required
Template used to create each scheduled session, in the same shape as the Create session body. Must contain at least one initial message and may not set parent_session_id. Defaults to max_time_s: 3600 when the template does not set it.
description
string
Optional description (max 255 characters).

Examples

Response

Errors