ForecastService

GetSimulationOutcome

GetSimulationOutcome returns the latest forecast simulation outcome, refreshed about hourly. The response note is set when a supplied runId does not match.

get/api/forecast/v1/get-simulation-outcome

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

runIdstring
Example:1789387200000-abc123

Optional run ID (epoch ms, hyphen, 1-64 char suffix; max 128). Returns that run's outcome within 24h retention, processing=true while it is queued, or the latest outcome with a note. Empty returns the latest outcome.

jmespathstring

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

OK

foundboolean
runIdstring
schemaVersionstring
theaterCountinteger
generatedAtinteger

Warning: Values > 2^53 may lose precision in JavaScript

notestring

Set when run_id was supplied but the latest outcome is returned instead; the text says why (run expired or not found, or its by-run record failed).

errorstring

Populated when the Redis lookup failed. Distinguish from healthy not-found (found=false, error=""). Value: "redis_unavailable" on Redis errors.

theaterSummariesJsonstring

JSON-encoded Array<{ theaterId, theaterLabel, stateKind, topPaths: [{label, summary, confidence, keyActors}], dominantReactions, stabilizers, invalidators }>; empty when found=false.

processingboolean

True when the supplied runId is still queued, as opposed to expired.

eligibleTheaterCountinteger

Number of theaters eligible for simulation in the package used by this outcome.

failedTheaterCountinteger

Number of eligible theaters that failed before producing a Round 2 result.

allTheatersFailedboolean

True when eligible_theater_count > 0 and no theater produced an outcome.

completionStatusstring

Machine-readable completion status. Current values: "completed", "partial", "no_eligible_theaters", or "all_theaters_failed".

Changes

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