Create a new schedule

client.agents.schedules.create(, , ?): AgentSchedule { metadata, spec, info }

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

Creates a new schedule for an agent

ParametersExpand Collapse

agentID: string

params: ScheduleCreateParams { workspaceId, metadata, spec }

workspaceId: string

Path param: Workspace ID.

metadata: CreateResourceMetadata { name, bundleKey, externalId, labels }

Body param: 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.

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

bundleKey?: string

Optional bundle ownership key. See ResourceMetadata.bundle_key.

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 }

Body param: 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.

ReturnsExpand 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

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)

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

Create a new schedule

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const agentSchedule = await client.agents.schedules.create('agentId', {
  workspaceId: 'workspaceId',
  metadata: { name: 'name' },
  spec: {
    initialMessage: 'initialMessage',
    schedule: {},
  },
});

console.log(agentSchedule.metadata);

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

Returns Examples

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