ScenarioService

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.

get/api/scenario/v1/get-scenario-status

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/scenario/v1/get-scenario-status
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key
    • HTTP bearer

Query parameters

jobIdstring required

Job id of the form scenario:{epoch_ms}:{32-hex} (128-bit). The legacy 8-character suffix remains valid. Path-traversal guarded by JOB_ID_RE.

jmespathstring

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

OK

statusstring
errorstring

Populated only when status == "failed".

Changes

No recorded changes to this operation across all 1 revision of this API.