API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Schedules

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

List schedules

client.agents.schedules.list(stringagentID, ScheduleListParams { workspaceId, bundleKey, cursor, 5 more } params, RequestOptionsoptions?): CursorPagination<AgentSchedule { metadata, spec, info } >

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

Create a new schedule

client.agents.schedules.create(stringagentID, ScheduleCreateParams { workspaceId, metadata, spec } params, RequestOptionsoptions?): AgentSchedule { metadata, spec, info }

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

Get a schedule by ID

client.agents.schedules.retrieve(stringid, ScheduleRetrieveParams { workspaceId, agentId } params, RequestOptionsoptions?): AgentSchedule { metadata, spec, info }

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

Delete a schedule

client.agents.schedules.delete(stringid, ScheduleDeleteParams { workspaceId, agentId } params, RequestOptionsoptions?): void

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

Update a schedule

client.agents.schedules.update(stringid, ScheduleUpdateParams { workspaceId, agentId, metadata, 2 more } params, RequestOptionsoptions?): AgentSchedule { metadata, spec, info }

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

ModelsExpand Collapse

AgentSchedule { metadata, spec, info }

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

metadata: ResourceMetadata { id, accountId, createdAt, 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…”)

accountId: string

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

createdAt: string

Timestamp when this resource was created

formatdate-time

name: string

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

profileId: string

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

workspaceId: string

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

bundleKey?: 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.

externalId?: string

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

labels?: Record<string, string>

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

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

AgentScheduleSpec is the user-provided configuration for a schedule.

initialMessage: 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, dayOfMonth, dayOfWeek, 4 more } >

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

comment?: string

dayOfMonth?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

dayOfWeek?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

hour?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

minute?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

month?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

second?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

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?: unknown

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

overlapPolicy?: "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"

variationId?: string

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

info?: AgentScheduleInfo { createdBy, lastFireAt, lastObjectiveId, 4 more }

AgentScheduleInfo provides read-only runtime data about a schedule.

createdBy?: 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, accountId, 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…”)

accountId: string

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

name: string

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

profileId: string

externalId?: string

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

labels?: Record<string, 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.

name?: string

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

lastFireAt?: string

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

formatdate-time

lastObjectiveId?: string

ID of the most recent objective the schedule created.

lastSkippedAt?: string

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

formatdate-time

lastSkipReason?: string

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

nextFireAt?: string

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

totalFires?: number

Lifetime count of objectives created by this schedule.

formatint32

AgentScheduleInfo { createdBy, lastFireAt, lastObjectiveId, 4 more }

AgentScheduleInfo provides read-only runtime data about a schedule.

createdBy?: 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, accountId, 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…”)

accountId: string

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

name: string

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

profileId: string

externalId?: string

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

labels?: Record<string, 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.

name?: string

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

lastFireAt?: string

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

formatdate-time

lastObjectiveId?: string

ID of the most recent objective the schedule created.

lastSkippedAt?: string

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

formatdate-time

lastSkipReason?: string

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

nextFireAt?: string

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

totalFires?: number

Lifetime count of objectives created by this schedule.

formatint32

AgentScheduleSpec { initialMessage, schedule, data, 3 more }

AgentScheduleSpec is the user-provided configuration for a schedule.

initialMessage: 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, dayOfMonth, dayOfWeek, 4 more } >

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

comment?: string

dayOfMonth?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

dayOfWeek?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

hour?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

minute?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

month?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

second?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

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?: unknown

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

overlapPolicy?: "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"

variationId?: string

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

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, dayOfMonth, dayOfWeek, 4 more } >

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

comment?: string

dayOfMonth?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

dayOfWeek?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

hour?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

minute?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

month?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

second?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

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.

ScheduleCalendar { comment, dayOfMonth, dayOfWeek, 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

dayOfMonth?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

dayOfWeek?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

hour?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

minute?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

month?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

second?: Array<ScheduleRange { end, start, step } >

end?: number

start?: number

step?: number

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).

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?: number

start?: number

step?: number