# Schedules

## List schedules

`agents.schedules.list(agent_id, **kwargs) -> CursorPagination<AgentSchedule>`

**get** `/v1/workspaces/{workspaceId}/agents/{agentId}/schedules`

Lists all schedules for an agent

### Parameters

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

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

### Returns

- `class AgentSchedule`

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

  - `metadata: ResourceMetadata`

    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

    - `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`

    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`

      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]`

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

        - `comment: String`

        - `day_of_month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `day_of_week: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `hour: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `minute: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `second: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

      - `intervals: Array[ScheduleInterval]`

        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.

      - `: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.

      - `: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`

    AgentScheduleInfo provides read-only runtime data about a schedule.

    - `created_by: Profile`

      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`

        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`

        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.

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

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

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

    - `total_fires: Integer`

      Lifetime count of objectives created by this schedule.

### Example

```ruby
require "cadenya"

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

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

puts(page)
```

#### Response

```json
{
  "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
  }
}
```

## Create a new schedule

`agents.schedules.create(agent_id, **kwargs) -> AgentSchedule`

**post** `/v1/workspaces/{workspaceId}/agents/{agentId}/schedules`

Creates a new schedule for an agent

### Parameters

- `workspace_id: String`

- `agent_id: String`

- `metadata: CreateResourceMetadata`

  CreateResourceMetadata contains the user-provided fields for creating
  a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id,
  created_at) are excluded since they are set by the server.

  - `name: String`

    Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")

  - `bundle_key: String`

    Optional bundle ownership key. See ResourceMetadata.bundle_key.

  - `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`

  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`

    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]`

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

      - `comment: String`

      - `day_of_month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `day_of_week: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `hour: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `minute: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `second: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

    - `intervals: Array[ScheduleInterval]`

      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.

    - `: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.

    - `: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.

### Returns

- `class AgentSchedule`

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

  - `metadata: ResourceMetadata`

    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

    - `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`

    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`

      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]`

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

        - `comment: String`

        - `day_of_month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `day_of_week: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `hour: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `minute: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `second: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

      - `intervals: Array[ScheduleInterval]`

        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.

      - `: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.

      - `: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`

    AgentScheduleInfo provides read-only runtime data about a schedule.

    - `created_by: Profile`

      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`

        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`

        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.

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

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

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

    - `total_fires: Integer`

      Lifetime count of objectives created by this schedule.

### Example

```ruby
require "cadenya"

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

agent_schedule = cadenya.agents.schedules.create(
  "agentId",
  workspace_id: "workspaceId",
  metadata: {name: "name"},
  spec: {initialMessage: "initialMessage", schedule: {}}
)

puts(agent_schedule)
```

#### Response

```json
{
  "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
  }
}
```

## Get a schedule by ID

`agents.schedules.retrieve(id, **kwargs) -> AgentSchedule`

**get** `/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}`

Retrieves a schedule by ID from an agent

### Parameters

- `workspace_id: String`

- `agent_id: String`

- `id: String`

### Returns

- `class AgentSchedule`

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

  - `metadata: ResourceMetadata`

    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

    - `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`

    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`

      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]`

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

        - `comment: String`

        - `day_of_month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `day_of_week: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `hour: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `minute: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `second: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

      - `intervals: Array[ScheduleInterval]`

        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.

      - `: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.

      - `: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`

    AgentScheduleInfo provides read-only runtime data about a schedule.

    - `created_by: Profile`

      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`

        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`

        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.

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

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

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

    - `total_fires: Integer`

      Lifetime count of objectives created by this schedule.

### Example

```ruby
require "cadenya"

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

agent_schedule = cadenya.agents.schedules.retrieve("id", workspace_id: "workspaceId", agent_id: "agentId")

puts(agent_schedule)
```

#### Response

```json
{
  "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
  }
}
```

## Delete a schedule

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

**delete** `/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}`

Deletes a schedule from an agent

### Parameters

- `workspace_id: String`

- `agent_id: String`

- `id: String`

### Example

```ruby
require "cadenya"

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

result = cadenya.agents.schedules.delete("id", workspace_id: "workspaceId", agent_id: "agentId")

puts(result)
```

## Update a schedule

`agents.schedules.update(id, **kwargs) -> AgentSchedule`

**patch** `/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}`

Updates a schedule for an agent

### Parameters

- `workspace_id: String`

- `agent_id: String`

- `id: String`

- `metadata: UpdateResourceMetadata`

  UpdateResourceMetadata contains the user-provided fields for updating
  a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id,
  created_at) are excluded since they are set by the server.

  - `name: String`

    Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")

  - `bundle_key: String`

    Optional bundle ownership key. See ResourceMetadata.bundle_key.

  - `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`

  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`

    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]`

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

      - `comment: String`

      - `day_of_month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `day_of_week: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `hour: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `minute: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `second: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

    - `intervals: Array[ScheduleInterval]`

      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.

    - `: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.

    - `: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.

- `update_mask: String`

  Fields to update.

### Returns

- `class AgentSchedule`

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

  - `metadata: ResourceMetadata`

    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

    - `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`

    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`

      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]`

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

        - `comment: String`

        - `day_of_month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `day_of_week: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `hour: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `minute: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `second: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

      - `intervals: Array[ScheduleInterval]`

        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.

      - `: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.

      - `: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`

    AgentScheduleInfo provides read-only runtime data about a schedule.

    - `created_by: Profile`

      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`

        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`

        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.

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

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

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

    - `total_fires: Integer`

      Lifetime count of objectives created by this schedule.

### Example

```ruby
require "cadenya"

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

agent_schedule = cadenya.agents.schedules.update("id", workspace_id: "workspaceId", agent_id: "agentId")

puts(agent_schedule)
```

#### Response

```json
{
  "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
  }
}
```

## Domain Types

### Agent Schedule

- `class AgentSchedule`

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

  - `metadata: ResourceMetadata`

    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

    - `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`

    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`

      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]`

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

        - `comment: String`

        - `day_of_month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `day_of_week: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `hour: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `minute: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `month: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

        - `second: Array[ScheduleRange]`

          - `end_: Integer`

          - `start: Integer`

          - `step: Integer`

      - `intervals: Array[ScheduleInterval]`

        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.

      - `: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.

      - `: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`

    AgentScheduleInfo provides read-only runtime data about a schedule.

    - `created_by: Profile`

      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`

        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`

        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.

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

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

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

    - `total_fires: Integer`

      Lifetime count of objectives created by this schedule.

### Agent Schedule Info

- `class AgentScheduleInfo`

  AgentScheduleInfo provides read-only runtime data about a schedule.

  - `created_by: Profile`

    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`

      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`

      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.

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

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

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

  - `total_fires: Integer`

    Lifetime count of objectives created by this schedule.

### Agent Schedule Spec

- `class AgentScheduleSpec`

  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`

    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]`

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

      - `comment: String`

      - `day_of_month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `day_of_week: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `hour: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `minute: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `month: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

      - `second: Array[ScheduleRange]`

        - `end_: Integer`

        - `start: Integer`

        - `step: Integer`

    - `intervals: Array[ScheduleInterval]`

      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.

    - `: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.

    - `: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.

### Agent Schedule Spec Schedule

- `class AgentScheduleSpecSchedule`

  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]`

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

    - `comment: String`

    - `day_of_month: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

    - `day_of_week: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

    - `hour: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

    - `minute: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

    - `month: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

    - `second: Array[ScheduleRange]`

      - `end_: Integer`

      - `start: Integer`

      - `step: Integer`

  - `intervals: Array[ScheduleInterval]`

    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.

### Schedule Calendar

- `class ScheduleCalendar`

  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_: Integer`

    - `start: Integer`

    - `step: Integer`

  - `day_of_week: Array[ScheduleRange]`

    - `end_: Integer`

    - `start: Integer`

    - `step: Integer`

  - `hour: Array[ScheduleRange]`

    - `end_: Integer`

    - `start: Integer`

    - `step: Integer`

  - `minute: Array[ScheduleRange]`

    - `end_: Integer`

    - `start: Integer`

    - `step: Integer`

  - `month: Array[ScheduleRange]`

    - `end_: Integer`

    - `start: Integer`

    - `step: Integer`

  - `second: Array[ScheduleRange]`

    - `end_: Integer`

    - `start: Integer`

    - `step: Integer`

### Schedule Interval

- `class ScheduleInterval`

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

### Schedule Range

- `class ScheduleRange`

  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`