Schedules

Manage recurring schedules attached to agents. Schedules trigger objectives on a cadence defined by AgentScheduleSpec.Schedule.

List schedules

agents.schedules.list(agent_id, **kwargs) -> CursorPagination<AgentSchedule { metadata, spec, info } >

GET/v1/workspaces/{workspaceId}/agents/{agentId}/schedules

Create a new schedule

agents.schedules.create(agent_id, **kwargs) -> AgentSchedule { metadata, spec, info }

POST/v1/workspaces/{workspaceId}/agents/{agentId}/schedules

Get a schedule by ID

agents.schedules.retrieve(id, **kwargs) -> AgentSchedule { metadata, spec, info }

GET/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}

Delete a schedule

agents.schedules.delete(id, **kwargs) -> void

DELETE/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}

Update a schedule

agents.schedules.update(id, **kwargs) -> AgentSchedule { metadata, spec, info }

PATCH/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}

ModelsExpand Collapse

class AgentSchedule { metadata, spec, info }

AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence.

metadata: ResourceMetadata { id, account_id, created_at, 6 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: String

Unique identifier for the resource (prefixed ULID, e.g., “agent_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

created_at: Time

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

ID of the actor (user or service account) that created this resource

workspace_id: String

Workspace this resource belongs to for organizational grouping (prefixed ULID)

bundle_key: String

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: AgentScheduleSpec { initial_message, schedule, data, 3 more }

AgentScheduleSpec is the user-provided configuration for a schedule.

initial_message: String

The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective’s chat history.

schedule: AgentScheduleSpecSchedule { calendars, intervals, timezone }

Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR’d together. At least one rule is required.

calendars: Array[ScheduleCalendar { comment, day_of_month, day_of_week, 4 more } ]

Wall-clock rules. May be empty if intervals is non-empty.

comment: String

day_of_month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

day_of_week: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

hour: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

minute: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

second: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

intervals: Array[ScheduleInterval { every, offset } ]

Duration-based rules. May be empty if calendars is non-empty.

every: String

offset: String

Phase shift within every. Must be < every (enforced at runtime).

timezone: String

IANA tz name (e.g. “America/New_York”). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone.

data: untyped

Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it.

overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP

What to do when the previous run is still in flight. Defaults to SKIP.

formatenum

One of the following:

:OVERLAP_POLICY_UNSPECIFIED

:OVERLAP_POLICY_ALLOW

:OVERLAP_POLICY_SKIP

status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED

Lifecycle. Defaults to ACTIVE on create when unspecified.

formatenum

One of the following:

:AGENT_SCHEDULE_STATUS_UNSPECIFIED

:AGENT_SCHEDULE_STATUS_ACTIVE

:AGENT_SCHEDULE_STATUS_PAUSED

:AGENT_SCHEDULE_STATUS_ARCHIVED

variation_id: String

Optional explicit variation. When unset, the agent’s variation_selection_mode chooses per fire.

info: AgentScheduleInfo { created_by, last_fire_at, last_objective_id, 4 more }

AgentScheduleInfo provides read-only runtime data about a schedule.

created_by: Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, account_id, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: String

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

:PROFILE_TYPE_UNSPECIFIED

:PROFILE_TYPE_USER

:PROFILE_TYPE_API_KEY

:PROFILE_TYPE_SYSTEM

email: String

Email address of the profile. Required and unique within an account for user profiles.

Display name (e.g., “Bobby Tables”).

last_fire_at: Time

When the schedule last fired (regardless of objective outcome).

formatdate-time

last_objective_id: String

ID of the most recent objective the schedule created.

last_skipped_at: Time

When the schedule most recently skipped a fire (SKIP policy + prior in flight).

formatdate-time

last_skip_reason: String

Reason for the most recent skip (e.g. “previous objective still running”).

next_fire_at: Time

When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times.

formatdate-time

total_fires: Integer

Lifetime count of objectives created by this schedule.

formatint32

class AgentScheduleInfo { created_by, last_fire_at, last_objective_id, 4 more }

AgentScheduleInfo provides read-only runtime data about a schedule.

created_by: Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, account_id, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: String

Unique identifier for the resource (prefixed ULID, e.g., “apikey_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

:PROFILE_TYPE_UNSPECIFIED

:PROFILE_TYPE_USER

:PROFILE_TYPE_API_KEY

:PROFILE_TYPE_SYSTEM

email: String

Email address of the profile. Required and unique within an account for user profiles.

Display name (e.g., “Bobby Tables”).

last_fire_at: Time

When the schedule last fired (regardless of objective outcome).

formatdate-time

last_objective_id: String

ID of the most recent objective the schedule created.

last_skipped_at: Time

When the schedule most recently skipped a fire (SKIP policy + prior in flight).

formatdate-time

last_skip_reason: String

Reason for the most recent skip (e.g. “previous objective still running”).

next_fire_at: Time

When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times.

formatdate-time

total_fires: Integer

Lifetime count of objectives created by this schedule.

formatint32

class AgentScheduleSpec { initial_message, schedule, data, 3 more }

AgentScheduleSpec is the user-provided configuration for a schedule.

initial_message: String

The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective’s chat history.

schedule: AgentScheduleSpecSchedule { calendars, intervals, timezone }

Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR’d together. At least one rule is required.

calendars: Array[ScheduleCalendar { comment, day_of_month, day_of_week, 4 more } ]

Wall-clock rules. May be empty if intervals is non-empty.

comment: String

day_of_month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

day_of_week: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

hour: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

minute: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

second: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

intervals: Array[ScheduleInterval { every, offset } ]

Duration-based rules. May be empty if calendars is non-empty.

every: String

offset: String

Phase shift within every. Must be < every (enforced at runtime).

timezone: String

IANA tz name (e.g. “America/New_York”). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone.

data: untyped

Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it.

overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP

What to do when the previous run is still in flight. Defaults to SKIP.

formatenum

One of the following:

:OVERLAP_POLICY_UNSPECIFIED

:OVERLAP_POLICY_ALLOW

:OVERLAP_POLICY_SKIP

status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED

Lifecycle. Defaults to ACTIVE on create when unspecified.

formatenum

One of the following:

:AGENT_SCHEDULE_STATUS_UNSPECIFIED

:AGENT_SCHEDULE_STATUS_ACTIVE

:AGENT_SCHEDULE_STATUS_PAUSED

:AGENT_SCHEDULE_STATUS_ARCHIVED

variation_id: String

Optional explicit variation. When unset, the agent’s variation_selection_mode chooses per fire.

class AgentScheduleSpecSchedule { calendars, intervals, timezone }

Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR’d together. At least one rule is required.

calendars: Array[ScheduleCalendar { comment, day_of_month, day_of_week, 4 more } ]

Wall-clock rules. May be empty if intervals is non-empty.

comment: String

day_of_month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

day_of_week: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

hour: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

minute: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

second: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

intervals: Array[ScheduleInterval { every, offset } ]

Duration-based rules. May be empty if calendars is non-empty.

every: String

offset: String

Phase shift within every. Must be < every (enforced at runtime).

timezone: String

IANA tz name (e.g. “America/New_York”). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone.

class ScheduleCalendar { comment, day_of_month, day_of_week, 4 more }

Calendar is a wall-clock rule. Empty field-list semantics:

second/minute/hour: empty means [{start: 0}] (top of the unit)
day_of_month/month/day_of_week: empty means “any value” Fire times = cartesian product across all fields.

comment: String

day_of_month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

day_of_week: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

hour: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

minute: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

month: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

second: Array[ScheduleRange { end_, start, step } ]

end_: Integer

start: Integer

step: Integer

class ScheduleInterval { every, offset }

Interval is a duration-based rule. Fires every every from a stable anchor (workspace epoch), optionally phase-shifted by offset.

every: String

offset: String

Phase shift within every. Must be < every (enforced at runtime).

class ScheduleRange { end_, start, step }

Inclusive numeric range with optional step. {start: 9} → 9 {start: 9, end: 17} → 9..17 {start: 0, end: 59, step: 15} → 0,15,30,45 end defaults to start; step defaults to 1.

end_: Integer

start: Integer

step: Integer