ForecastService

TriggerSimulation

TriggerSimulation enqueues a simulation run for the current package outside the hourly cycle. PRO-gated. Poll GetSimulationOutcome with the returned runId. Requires entitlement tier >= 1.

post/api/forecast/v1/trigger-simulation

Request

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

Headers

Idempotency-Keystring

Optional client-generated idempotency key. Retrying a POST with the same key and an identical request body replays the original response (only the status, body, and Content-Type are reproduced) instead of re-executing; reusing the key with a different body is rejected with 422. For mutations this avoids duplicating the side effect, while for batch-read POSTs it replays a cached snapshot that can be up to 24 hours stale. Keys are scoped per authenticated caller (falling back to the source IP for unauthenticated endpoints) and retained for 24 hours.

Request body

clientVersionstring

Optional client version, such as "mcp-client/0.2". Logged, never stored.

Response

OK

queuedboolean

True when the task was newly enqueued; false on idempotency hit or no_package.

runIdstring

Server-derived runId from SIMULATION_PACKAGE_LATEST_KEY. Empty string when reason='no_package' (no package pointer was available).

pkgFingerprintstring

Opaque fingerprint of the package key; it changes when the key changes. Empty when reason='no_package'.

reasonstring

'' when queued, 'no_package' when no package exists, or 'already-handled' when this cycle's run is already queued or done.

Changes

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