Skip to main content
estimate_usage Estimate shared Monitor credits before a check, lookup, crawl or schedule change. Reads only; provider availability and admission are rechecked at start. Saved reports and exports use no new credits.
This command name is absent from deployment evidence dated 2026-10-17. Hosted availability for this current definition is unverified; inspect your connected catalog before invoking it. Verify the command and its input schema in the selected environment.
This read does not start a verification job.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Validation and omitted values

Read-only estimate: it creates no reservation or financial hold, starts no check or crawl, and does not activate a provider. An accepted shared-credit Monitor contract is required. Legacy subscriptions keep their existing allowance; use get_usage for authoritative usage and billing terms. The response reports maximumCredits for the proposed work, alongside current-period remainingCredits, protectedCredits for scheduled monitoring, and availableCredits for new work. The period is null when none is current. Protection is a forecast, not another financial hold; enforcementActive states whether shared-credit protection is active. The quote expires after five minutes or at the current billing-period end, whichever comes first. Starting work rechecks current admission, allowance, monitoring protection and provider availability. For action check with watchIds, maximumCredits is two credits per selected watch for the composite source and destination checks. Without watchIds, check uses quantity; check_target estimates explicit destination checks. For action monitor, proposed source or destination schedules replace the selected records’ existing forecast. maximumCredits is the nonnegative increase, projectedMonitoringCredits is their proposed total, and forecastMonitoringCredits is the revised workspace total. Enabling a schedule itself is uncharged. For action scan_schedule, maximumCredits aggregates bounded scans through the current period using a first scan now and then weekly (604800 seconds) or monthly (2592000 seconds). This is a forecast; actual starts depend on retained runs and current controls. Operational page and daily caps still apply. A lookup is 1000 credits including its initial verification. A crawl is 20 credits per newly admitted page including ordinary rendering and bounded retries. Retained reads and saved AI citation reports use no new credits and do not collect new provider answers. Omitting quantity uses one logical action. For crawl and scan_schedule, the page maximum uses pageLimit, then an explicit quantity, otherwise 300 pages; scan_schedule defaults to weekly. For monitor, selected records keep their cadence unless cadenceSeconds is supplied; without selected records, the defaults are one record and daily checks.

Defaults when omitted

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.
  • estimate (object, required).
Download input schema · Download output schema

Errors and retries

Follow the error recovery before retrying this read. Preserve the selected workspace, project, filters and feed. Recovering a read does not require an idempotency key or another verification job. Operation-specific errors include BILLING_MONITOR_PLAN_REQUIRED, PROJECT_ACCESS_DENIED, INVALID_CADENCE. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

Continue

get_usage · get_workspace Follow the related workflow, inspect capability status, or return to the command index.