read

Run an action through the store's own gates against its real state, and keep nothing.

Returns what each gate would decide — store_rail (the merchant's own rules), policy (kill switch, dry-run, automation, rate limits, LLM budget), ownership (who holds the field, via field), and ceiling:ad_spend / ceiling:money_out (the company ceilings, via spend or money_out) — each as allow, clamp, review, deny, not_evaluated or unavailable, plus the refusals and clamps collected. The run is one database transaction that is always aborted; shadow.status reports aborted or the call fails. mode and autonomy default to the store's marketing plan and may be set to ask a what-if. would_run is the one field to branch on. Differs from /api/v1/preflight, which is public, reads no store, and judges against the published guardbook only.

post/api/v1/simulate

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/simulate
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: automation:read)

Request body

store_idstring uuid

The store to simulate against. Defaults to the store the credential was issued for.

domainstring required

e.g. ads_google, pricing, feed.

actionstring required

The verb, e.g. adjust_budget.

factsobject

What the store's rules match on (e.g. discount_pct, budget_change_pct).

confidencenumber
reversibility_class'reversible' | 'compensatable' | 'irreversible'
mode'off' | 'dry_run' | 'approval_only' | 'autopilot'
autonomy'conservative' | 'moderate' | 'aggressive'
rate_actionstring
automation_featurestring
kill_scopestring
estimated_llm_cost_usdnumber

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.