SCscaleapi
Schedules

Create Run Schedule

Changed on

Create a recurring schedule that starts a fresh agent run on each fire.

post/agents/{agent_id}/schedules

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

agent_idstring required

Request body

namestring required

Human-readable name, unique among active schedules for the agent.

descriptionstring nullable

Optional description of what this schedule does.

cron_expressionstring nullable

Cron expression for the cadence (e.g. '0 17 * * MON-FRI'). Mutually exclusive with interval_seconds.

interval_secondsinteger nullable

Interval cadence in seconds. Mutually exclusive with cron_expression.

timezonestring

IANA timezone the cron expression is evaluated in (e.g. 'America/New_York').

start_atstring date-time nullable

When the schedule should start being active.

end_atstring date-time nullable

When the schedule should stop being active.

pausedboolean

Whether to create the schedule in a paused state.

task_paramsobject nullable

Resolved config forwarded as task params at fire time.

task_metadataobject nullable

Metadata copied onto each created task at fire time.

Response

Successful Response

idstring required

The unique identifier of the run schedule.

agent_idstring required

The agent this schedule belongs to.

namestring required

Human-readable schedule name.

descriptionstring nullable

Optional description.

cron_expressionstring nullable

Cron cadence, if cron-based.

interval_secondsinteger nullable

Interval cadence in seconds, if interval-based.

timezonestring

Timezone the cron expression is evaluated in.

start_atstring date-time nullable

Schedule activation time.

end_atstring date-time nullable

Schedule deactivation time.

pausedboolean

Whether the schedule is paused.

task_paramsobject nullable

Task params at fire time.

task_metadataobject nullable

Task metadata at fire time.

initial_input_methodstring required

Delivery method, inferred from the agent's ACP type.

created_atstring date-time nullable

When the schedule was created.

updated_atstring date-time nullable

When the schedule was updated.

state'ACTIVE' | 'PAUSED'

Live state of a run schedule, derived from Temporal.

next_action_timesstring[]

Upcoming scheduled fire times.

live_data_availableboolean nullable

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

skipped_action_timesstring[]

Skipped one-off scheduled fire times.

last_action_timestring date-time nullable

When the schedule last fired.

num_actions_takeninteger

Number of times the schedule has fired.

Changes

  • 8f725ddc153eRevision changes
    • info

      added the optional property to the response with the status

  • fbecbdbd7dc5Revision changes
    • breaking

      added the new required request property

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      api operation id create_schedule_agents__agent_id__schedules_post removed and replaced with create_run_schedule_agents__agent_id__schedules_post

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value ACTIVE was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status