- Badges are explained under Approvals.
project_idis optional on most tools; without it, the server picks a project for that call only (Projects).expected_organization_idis an optional string on every write tool, omitted from parameter tables; passorganization.idfromget_identity(Organization check).limitvalues above a tool’s maximum are capped, not refused.
Tools
list_schedules
List schedules. Lists a project’s schedules, newest first, withnextRunAt, 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 beforemanage_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.
shortfallis a warning, not a refusal. It’s null while your runs cover the launches, or while the schedule is paused. Otherwise it givesat(the first uncovered launch),runsShort,availableRuns,launchesCovered,runsToAdd(to cover every launch untiluntil),until,untilReset(true whenuntilis your next run reset), amessage, and anactionlinking Usage & billing.blockerslists everything that would stop a launch now, each with acode,message, andactionwith 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 withschedule_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, withdetails.blockersshaped as inpreview_schedule; the message is the blocker’s own, or a count when there are several. updatechanges 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,
resumechecks the launch and resumes. If something still blocks it, give the person every fix link indetails.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_idfor a different schedule change returnsschedule_attempt_reused. Missing schedules returnschedule_not_found. - To launch a schedule now, call
rerun_experimentwithschedule_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.
Related
Experiments tools
Launch a schedule’s experiment now with
rerun_experiment.oqoqo schedules
The matching CLI commands and flags.

