Skip to main content
GET
GetSimulationOutcome

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

runId
string

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.

Maximum string length: 128
Pattern: ^([0-9]{13,}-[A-Za-z0-9-]{1,64})?$
Example:

"1789387200000-abc123"

jmespath
string

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

found
boolean
runId
string
schemaVersion
string
theaterCount
integer<int32>
generatedAt
integer<int64>

Unix timestamp in milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript

note
string

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).

error
string

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

theaterSummariesJson
string

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

processing
boolean

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

eligibleTheaterCount
integer<int32>

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

failedTheaterCount
integer<int32>

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

allTheatersFailed
boolean

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

completionStatus
string

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