GetSimulationOutcome
GetSimulationOutcome returns the latest stored forecast simulation outcome; the response note is populated when a supplied runId does not match the returned outcome.
Authorizations
User-issued WorldMonitor API key.
Query Parameters
Filter is active for outcomes within the 24h retention window (#3734). If runId is supplied:
- Hit on the by-run key → returns that outcome, processing=false.
- By-run lookup returns the tombstone (worker write transiently failed) → falls through to :latest with a 'note' describing the transient failure.
- No by-run match but runId is in the queue → returns processing=true.
- No match anywhere → falls back to :latest with a 'note' describing expiry-or-mismatch. If runId is empty: returns :latest (existing behavior).
Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.
Response
Successful response
Unix timestamp in milliseconds (from Date.now()). Warning: Values > 2^53 may lose precision in JavaScript.. Warning: Values > 2^53 may lose precision in JavaScript
Populated when req.runId was supplied but does not match the returned outcome's runId, or when the by-run lookup returned a tombstone (Redis transient write failure). Distinguishes "your runId expired beyond 24h retention" from "by-run lookup failed (Redis transient); returned latest" so callers can react differently.
Populated when the Redis lookup failed. Distinguish from healthy not-found (found=false, error=""). Value: "redis_unavailable" on Redis errors.
JSON-encoded array of theater summaries for the UI (populated when found=true). Shape: Array<{ theaterId, theaterLabel, stateKind, topPaths: [{label, summary, confidence, keyActors}], dominantReactions, stabilizers, invalidators }> Parse with JSON.parse() on the client. Empty string when found=false.
True when req.runId was supplied AND the runId is currently in the simulation queue (worker hasn't drained yet). Distinguishes "your run is processing" from "your run expired beyond retention" — both previously returned NOT_FOUND. Added in #3734 to prevent the 30-day demand experiment from being contaminated by the queued-vs-expired indistinguishability.
Number of theaters eligible for simulation in the package used by this outcome.
Number of eligible theaters that failed before producing a Round 2 result.
True when eligible_theater_count > 0 and no theater produced an outcome.
Machine-readable completion status. Current values: "completed", "partial", "no_eligible_theaters", or "all_theaters_failed".
