Skip to main content
Check your organization’s run balance, read balance history, and manage your notifications.
  • Badges are explained under Approvals.
  • Organization vs. project scope: inspect_quota, list_quota_ledger, inspect_notification_preferences, and manage_notification_preferences are organization- or account-wide and do not take project_id. list_notifications and acknowledge_notifications act across every project in the organization when project_id is omitted.
  • 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

inspect_quota

Get the run balance. Returns the run balance, and whether a launch of requested_runs runs can start now. It offers no purchases or billing actions. Read-only · CLI: oqoqo quota inspect Result fields remainingRuns, reservedRuns, usedRuns, totalRuns, remainingBreakdown, state, and readiness, as in oqoqo quota inspect. The plugin returns no billingUrl.

list_quota_ledger

List run balance history. Returns a page of run balance transactions. It offers no purchases or billing actions. Read-only · CLI: oqoqo quota ledger Result fields Each entry has a qtx_ transactionId, type, amount, effectiveAt, expiresAt, source, and the experimentId and link of the experiment that caused it, if any. hasMore and nextCursor page the list.

list_notifications

List notifications. Returns a page of your notifications, optionally for one project. Read-only · CLI: oqoqo notifications list Result fields Each notification has notificationId, insertedAt, status, title, and a safe link. A schedule’s paused, skipping, and short-of-runs notices, and the problem notices of the experiments it launched, also carry its scheduleId, which you can read with get_schedule.

acknowledge_notifications

Mark notifications as read. Marks one notification, or up to 500 unread ones, optionally in one project. Repeating a call gives the same result. Changes data · CLI: oqoqo notifications acknowledge Result fields acknowledgedCount and, with all, hasMore. Repeat the call while hasMore is true.

inspect_notification_preferences

Get notification preferences. Returns your account-wide setting for each category and channel, and whether each can be changed, is required, or doesn’t apply. Read-only · CLI: oqoqo notifications preferences This tool takes no parameters.

manage_notification_preferences

Change notification preferences. Changes only the categories and channels you send. The rest stay as they are. Changes data · CLI: oqoqo notifications preferences update For example, {"experiment-updates": {"email": false, "in-app": true}} keeps experiment updates in-app only.

oqoqo quota and notifications

The matching CLI commands.

Runs and billing

Plans, top-ups, and run balance rules.