Skip to main content
GET
GetScenarioStatus

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

jobId
string
required

Job id of the form scenario:{epoch_ms}:{8-char-suffix}. Path-traversal guarded by JOB_ID_RE in the handler.

Pattern: ^scenario:[0-9]{13}:[a-z0-9]{8}$
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

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.

status
string
result
object

ScenarioResult is the computed payload the scenario-worker writes back under the scenario-result:{job_id} Redis key. Populated only when GetScenarioStatusResponse.status == "done".

error
string

Populated only when status == "failed".