> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # GetSimulationOutcome > GetSimulationOutcome returns the latest stored forecast simulation outcome; the response note is populated when a supplied runId does not match the returned outcome. ## OpenAPI ````yaml /api/ForecastService.openapi.yaml get /api/forecast/v1/get-simulation-outcome openapi: 3.1.0 info: title: ForecastService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/forecast/v1/get-simulation-outcome: get: tags: - ForecastService summary: GetSimulationOutcome description: >- GetSimulationOutcome returns the latest stored forecast simulation outcome; the response note is populated when a supplied runId does not match the returned outcome. operationId: GetSimulationOutcome parameters: - name: runId in: query description: >- 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). required: false example: example-id schema: type: string - name: jmespath in: query description: >- 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. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: allTheatersFailed: true completionStatus: example eligibleTheaterCount: 1 error: example failedTheaterCount: 1 schema: $ref: '#/components/schemas/GetSimulationOutcomeResponse' '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- API access requires an active subscription (the API key's subscription is inactive or expired). content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetSimulationOutcomeResponse: type: object properties: found: type: boolean runId: type: string schemaVersion: type: string theaterCount: type: integer format: int32 generatedAt: type: integer format: int64 description: >- 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: type: string description: >- 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: type: string description: >- Populated when the Redis lookup failed. Distinguish from healthy not-found (found=false, error=""). Value: "redis_unavailable" on Redis errors. theaterSummariesJson: type: string description: >- 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: type: boolean description: >- 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: type: integer format: int32 description: >- Number of theaters eligible for simulation in the package used by this outcome. failedTheaterCount: type: integer format: int32 description: >- Number of eligible theaters that failed before producing a Round 2 result. allTheatersFailed: type: boolean description: >- True when eligible_theater_count > 0 and no theater produced an outcome. completionStatus: type: string description: |- Machine-readable completion status. Current values: "completed", "partial", "no_eligible_theaters", or "all_theaters_failed". ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). ````