Skip to content
cadenya
Get started
API Reference
Agents
Schedules

List schedules

agents.schedules.list(agent_id, **kwargs) -> CursorPagination<AgentSchedule { metadata, spec, info } >
GET/v1/workspaces/{workspaceId}/agents/{agentId}/schedules

Lists all schedules for an agent

ParametersExpand Collapse
workspace_id: String
agent_id: String
bundle_key: String

Filter by bundle_key — return only resources owned by this bundle.

cursor: String

Pagination cursor from previous response.

include_info: bool

When true, the info field on each returned schedule is populated. Requests with this flag count more against your rate limit.

limit: Integer

Maximum number of results to return.

formatint32
prefix: String

Filter expression (query param: prefix).

query: String

Free-form search query.

sort_order: String

Sort order for results (asc or desc by creation time).

ReturnsExpand 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
name: String

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)

name: String

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.

name: String

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

List schedules

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.agents.schedules.list("agentId", workspace_id: "workspaceId")

puts(page)
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "bundleKey": "bundleKey",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "initialMessage": "initialMessage",
        "schedule": {
          "calendars": [
            {
              "comment": "comment",
              "dayOfMonth": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "dayOfWeek": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "hour": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "minute": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "month": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "second": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ]
            }
          ],
          "intervals": [
            {
              "every": "-160513s",
              "offset": "-160513s"
            }
          ],
          "timezone": "timezone"
        },
        "data": {},
        "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED",
        "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED",
        "variationId": "variationId"
      },
      "info": {
        "createdBy": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "name": "name",
            "profileId": "profileId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          },
          "spec": {
            "type": "PROFILE_TYPE_UNSPECIFIED",
            "email": "email",
            "name": "name"
          }
        },
        "lastFireAt": "2019-12-27T18:11:19.117Z",
        "lastObjectiveId": "lastObjectiveId",
        "lastSkippedAt": "2019-12-27T18:11:19.117Z",
        "lastSkipReason": "lastSkipReason",
        "nextFireAt": "2019-12-27T18:11:19.117Z",
        "totalFires": 0
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}
Returns Examples
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "bundleKey": "bundleKey",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "initialMessage": "initialMessage",
        "schedule": {
          "calendars": [
            {
              "comment": "comment",
              "dayOfMonth": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "dayOfWeek": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "hour": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "minute": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "month": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ],
              "second": [
                {
                  "end": 0,
                  "start": 0,
                  "step": 0
                }
              ]
            }
          ],
          "intervals": [
            {
              "every": "-160513s",
              "offset": "-160513s"
            }
          ],
          "timezone": "timezone"
        },
        "data": {},
        "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED",
        "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED",
        "variationId": "variationId"
      },
      "info": {
        "createdBy": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "name": "name",
            "profileId": "profileId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          },
          "spec": {
            "type": "PROFILE_TYPE_UNSPECIFIED",
            "email": "email",
            "name": "name"
          }
        },
        "lastFireAt": "2019-12-27T18:11:19.117Z",
        "lastObjectiveId": "lastObjectiveId",
        "lastSkippedAt": "2019-12-27T18:11:19.117Z",
        "lastSkipReason": "lastSkipReason",
        "nextFireAt": "2019-12-27T18:11:19.117Z",
        "totalFires": 0
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}