Deployments.ai Docs
Command reference

deployments schedule

Scheduled agent runs

CommandSummary
deployments schedule createCreate a schedule
deployments schedule listList schedules
deployments schedule showShow a schedule
deployments schedule updateUpdate a schedule
deployments schedule archiveArchive a schedule
deployments schedule pausePause a schedule
deployments schedule resumeResume a schedule
deployments schedule firesList schedule fire history
deployments schedule fireFire a schedule now

deployments schedule create

Create a schedule.

deployments schedule create --name <name> --agent-deployment-id <agent-deployment-id> --expression <expression> --prompt <prompt>
  • Calls POST /v1/schedules (SDK createSchedule).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--agent-deployment-idstringyesAgent deployment ID
--expressionstringyesEventBridge cron, rate, or at expression
--promptstringyesPrompt for each scheduled run
--thread-idstringConversation thread for scheduled runs
--timezonestringIANA timezone
--workspace-idstringWorkspace ID

Also accepts the global flags.

deployments schedule list

List schedules.

deployments schedule list
  • Calls GET /v1/schedules (SDK listSchedules).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments schedule show

Show a schedule.

deployments schedule show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments schedule update

Update a schedule.

deployments schedule update <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expressionstringEventBridge cron, rate, or at expression
--namestringSchedule name
--promptstringPrompt for each scheduled run
--clear-timezonebooleanClear the schedule timezone
--timezonestringIANA timezone

Also accepts the global flags.

deployments schedule archive

Archive a schedule.

deployments schedule archive <id>
  • Calls DELETE /v1/schedules/{scheduleId} (SDK archiveSchedule).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments schedule pause

Pause a schedule.

deployments schedule pause <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments schedule resume

Resume a schedule.

deployments schedule resume <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments schedule fires

List schedule fire history.

deployments schedule fires <id>
  • Calls GET /v1/schedules/{scheduleId}/fires (SDK listScheduleFires).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<id>positionalyesResource ID

Also accepts the global flags.

deployments schedule fire

Fire a schedule now.

deployments schedule fire <id>
  • Calls POST /v1/schedules/{scheduleId}/fire (SDK fireSchedule).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--fire-keystringStable fire key

Also accepts the global flags.

On this page