GetSimulationOutcome

curl --request GET \
  --url https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome \
  --header 'X-WorldMonitor-Key: <api-key>'

import requests

url = "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome"

headers = {"X-WorldMonitor-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};

fetch('https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-WorldMonitor-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-WorldMonitor-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "allTheatersFailed": true,
  "completionStatus": "example",
  "eligibleTheaterCount": 1,
  "error": "example",
  "failedTheaterCount": 1
}

{
  "violations": [
    {
      "field": "<string>",
      "description": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "code": "subscription_lapsed",
  "requiredTier": 123,
  "currentTier": 123,
  "planKey": "<string>"
}

{
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "renewal_verification_pending",
  "requiredTier": 123
}

{
  "message": "<string>"
}

GET

api

forecast

get-simulation-outcome

GetSimulationOutcome

curl --request GET \
  --url https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome \
  --header 'X-WorldMonitor-Key: <api-key>'

import requests

url = "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome"

headers = {"X-WorldMonitor-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};

fetch('https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-WorldMonitor-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-WorldMonitor-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.worldmonitor.app/api/forecast/v1/get-simulation-outcome")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "allTheatersFailed": true,
  "completionStatus": "example",
  "eligibleTheaterCount": 1,
  "error": "example",
  "failedTheaterCount": 1
}

{
  "violations": [
    {
      "field": "<string>",
      "description": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "code": "subscription_lapsed",
  "requiredTier": 123,
  "currentTier": 123,
  "planKey": "<string>"
}

{
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "renewal_verification_pending",
  "requiredTier": 123
}

{
  "message": "<string>"
}

Authorizations

X-WorldMonitor-Key

string

header

required

User-issued WorldMonitor API key.

Query Parameters

runId

string

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

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

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

processing

boolean

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.

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