> ## 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. # GetScenarioStatus > GetScenarioStatus polls a single job's result. PRO-gated. Returns status="pending" when no result key exists, mirroring the worker's lifecycle state once the key is written. Requires entitlement tier >= 1. ## OpenAPI ````yaml /api/worldmonitor.openapi.yaml get /api/scenario/v1/get-scenario-status openapi: 3.1.0 info: title: WorldMonitor API description: >- Unified OpenAPI bundle spanning all WorldMonitor services. Versioning and deprecation policy: https://www.worldmonitor.app/docs/api-versioning contact: name: WorldMonitor email: support@worldmonitor.app version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/scenario/v1/get-scenario-status: get: tags: - ScenarioService summary: GetScenarioStatus description: |- GetScenarioStatus polls a single job's result. PRO-gated. Returns status="pending" when no result key exists, mirroring the worker's lifecycle state once the key is written. Requires entitlement tier >= 1. operationId: GetScenarioStatus parameters: - name: jobId in: query description: >- Job id of the form `scenario:{epoch_ms}:{8-char-suffix}`. Path-traversal guarded by JOB_ID_RE in the handler. required: true example: scenario:1717200000000:abcd1234 schema: type: string pattern: ^scenario:[0-9]{13}:[a-z0-9]{8}$ - 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: result: affectedChokepointIds: - hormuz_strait template: costShockMultiplier: 2.1 disruptionPct: 100 durationDays: 14 name: hormuz_strait topImpactCountries: - impactPct: 100 iso2: US totalImpact: 42.5 status: done schema: $ref: >- #/components/schemas/worldmonitor_scenario_v1_GetScenarioStatusResponse '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: PRO entitlement access denied. headers: X-Billing-Verification: description: >- Present when the 403 is a billing-provider-confirmed subscription lapse (value subscription_lapsed, matching the body `code`). schema: type: string 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' '503': description: >- Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape. headers: Retry-After: description: Seconds to wait before retrying (1-60). schema: type: string X-Billing-Verification: description: >- Billing-verification state that produced this response (matches the body `code`). schema: type: string X-Validation-Mode: description: >- Present with value degraded when user API-key validation is temporarily unavailable. schema: type: string X-RateLimit-Mode: description: >- Present with value degraded when a fail-closed rate-limit dependency is unavailable. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/BillingVerificationError' - $ref: '#/components/schemas/GatewayError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' security: - WorldMonitorKey: [] - ApiKeyHeader: [] - BearerAuth: [] components: schemas: worldmonitor_scenario_v1_GetScenarioStatusResponse: type: object properties: status: type: string result: $ref: '#/components/schemas/worldmonitor_scenario_v1_ScenarioResult' error: type: string description: Populated only when status == "failed". description: |- GetScenarioStatusResponse reflects the worker's lifecycle state. "pending" — no key yet (job still queued or very-recent enqueue). "processing" — worker has claimed the job but hasn't completed compute. "done" — compute succeeded; `result` is populated. "failed" — compute errored; `error` is populated. 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. code: type: string enum: - subscription_lapsed description: >- Machine-readable denial code, present when the 403 is a billing-provider-confirmed subscription lapse (mirrored in the X-Billing-Verification response header). 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 BillingVerificationError: type: object description: >- Returned with HTTP 503 when paid access cannot be confirmed right now: the billing provider is re-verifying a recently expired subscription, or the entitlement backend is unreachable. Retryable — honor Retry-After. properties: error: type: string description: Human-readable billing-verification failure reason. code: type: string enum: - renewal_verification_pending - renewal_verification_failed - entitlement_verification_unavailable description: >- Machine-readable billing-verification state, mirrored in the X-Billing-Verification response header. requiredTier: type: integer format: int32 description: >- Minimum entitlement tier required for this endpoint, when the denial came from a tier gate. required: - error - code 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 worldmonitor_scenario_v1_ScenarioResult: type: object properties: affectedChokepointIds: type: array items: type: string description: Chokepoint ids disrupted by this scenario. topImpactCountries: type: array items: $ref: >- #/components/schemas/worldmonitor_scenario_v1_ScenarioImpactCountry template: $ref: '#/components/schemas/worldmonitor_scenario_v1_ScenarioResultTemplate' description: |- ScenarioResult is the computed payload the scenario-worker writes back under the `scenario-result:{job_id}` Redis key. Populated only when GetScenarioStatusResponse.status == "done". 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. worldmonitor_scenario_v1_ScenarioImpactCountry: type: object properties: iso2: type: string description: 2-letter ISO country code. totalImpact: type: number format: double description: >- Raw weighted impact value aggregated across the country's exposed HS2 chapters. Physical scenarios use exposureScore * (disruption_pct / 100) * cost_shock_multiplier; tariff-shock scenarios use vulnerabilityIndex * cost_shock_multiplier. Relative-only - not a currency amount. impactPct: type: integer format: int32 description: >- Impact as a 0-100 share of max(maxReturnedTotalImpact, 1), capped at 100. Because of the denominator floor, the top country can be below 100 when all returned totalImpact values are below 1. description: >- ScenarioImpactCountry carries a single country's relative scenario impact score. worldmonitor_scenario_v1_ScenarioResultTemplate: type: object properties: name: type: string description: >- Worker-derived template key, not a display name. Physical scenarios join affected_chokepoint_ids with `+`; tariff-type scenarios may use `tariff_shock` when no physical chokepoint is affected. disruptionPct: type: integer format: int32 description: 0-100 percent of chokepoint capacity blocked. durationDays: type: integer format: int32 description: Estimated duration of disruption in days. costShockMultiplier: type: number format: double description: Freight cost multiplier applied on top of bypass corridor costs. description: >- ScenarioResultTemplate carries template parameters echoed into the worker's computed result so clients can render them without re-looking up the template registry. 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). BearerAuth: type: http scheme: bearer description: >- Bearer token: a Clerk-issued JWT for browser session flows, passed as Authorization: Bearer . ````