Skip to main content
Schedule finished experiments to launch again on a cron cadence. See Schedules for permissions, pause causes, and limits.
  • Badges are explained under Approvals.
  • project_id is optional on most tools; without it, the server picks a project for that call only (Projects).
  • expected_organization_id is an optional string on every write tool, omitted from parameter tables; pass organization.id from get_identity (Organization check).
  • limit values above a tool’s maximum are capped, not refused.

Tools

list_schedules

List schedules. Lists a project’s schedules, newest first, with nextRunAt, the person each runs as, the last result, and needsAttention with pauseReason when Oqoqo paused it. Read-only · CLI: oqoqo schedules list For a schedule’s experiments, call list_experiments with schedule_id.

get_schedule

Get a schedule. Returns its cadence in plain words, nextRunAt, experiment, run use, last result, and the lock_version a change needs. Read-only · CLI: oqoqo schedules get Result fields runsPerLaunch is the runs each launch uses. runsPer30Days is the runs in the next 30 days, not a monthly average. It’s 0 while the schedule is paused, or when no launch falls in the next 30 days.

preview_schedule

Preview a schedule. Shows what a new schedule or a change would do. Call it before manage_schedule and tell the person the runs it uses. Read-only · CLI: oqoqo schedules preview Result fields The preview has the cadence in plain words, the time zone it stores, the next 3 launches, runsPerLaunch, and runsPer30Days. A preview of a paused schedule counts it as resumed, and schedule.status says whether a changed schedule stays paused.
  • shortfall is a warning, not a refusal. It’s null while your runs cover the launches, or while the schedule is paused. Otherwise it gives at (the first uncovered launch), runsShort, availableRuns, launchesCovered, runsToAdd (to cover every launch until until), until, untilReset (true when until is your next run reset), a message, and an action linking Usage & billing.
  • blockers lists everything that would stop a launch now, each with a code, message, and action with its fix link, so the person can fix them all at once. While it isn’t empty, a create, a resume, or a change to the experiment, cron, or time zone refuses with schedule_launch_blocked. blocker (the first one) is for older CLI releases.

manage_schedule

Create or change a schedule. Creates, changes, pauses, or resumes a schedule. Each launch uses the project’s tasks, treatments, and agents as they are then. Changes data · You approve each call · CLI: oqoqo schedules create, oqoqo schedules update, oqoqo schedules pause, oqoqo schedules resume
  • A create, a resume, or a change to the experiment, cron, or time zone checks the launch as you, and makes you the person the schedule runs as. If blocked, it refuses with schedule_launch_blocked, with details.blockers shaped as in preview_schedule; the message is the blocker’s own, or a count when there are several.
  • update changes only the fields you send. A schedule still named after its experiment takes the new experiment’s name.
  • Oqoqo pauses a schedule when a launch needs a fix, or after 3 scheduled launches in a row fail. A checked change clears the reason, but the schedule stays paused until you resume it.
  • After the person fixes the cause, resume checks the launch and resumes. If something still blocks it, give the person every fix link in details.blockers, then resume again. Pause and resume are safe to repeat, and resume never launches at once.
  • A create or resume past 50 active schedules in a project returns schedule_limit_reached.
  • Reusing an attempt_id for a different schedule change returns schedule_attempt_reused. Missing schedules return schedule_not_found.
  • To launch a schedule now, call rerun_experiment with schedule_id.

delete_schedule

Delete a schedule. Deletes a schedule. The experiments it launched stay. Destructive · Irreversible · CLI: oqoqo schedules delete An already deleted schedule returns schedule_not_found.

Experiments tools

Launch a schedule’s experiment now with rerun_experiment.

oqoqo schedules

The matching CLI commands and flags.