Skip to main content
GET
GetSimulationPackage

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

runId
string

Optional run identifier. Does not select the package — the latest stored package is always returned regardless of this value. When supplied and it differs from the returned package's runId, the response note field is populated to warn that per-run filtering is not yet active. Reserved for Phase 3 per-run lookup.

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 (from Date.now()). Warning: Values > 2^53 may lose precision in JavaScript.. Warning: Values > 2^53 may lose precision in JavaScript

note
string

Populated when req.runId was supplied but does not match the returned package's runId. Indicates that per-run filtering is not yet active and the latest package was returned instead.

error
string

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