> ## 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. # GetRegionalSnapshot > GetRegionalSnapshot returns the latest persisted RegionalSnapshot for a region. The snapshot is written every 6h by scripts/seed-regional-snapshots.mjs; this handler only reads canonical state. Premium-gated. PRO-gated. Requires an active Pro subscription. ## OpenAPI ````yaml /api/IntelligenceService.openapi.yaml get /api/intelligence/v1/get-regional-snapshot openapi: 3.1.0 info: title: IntelligenceService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/intelligence/v1/get-regional-snapshot: get: tags: - IntelligenceService summary: GetRegionalSnapshot description: |- GetRegionalSnapshot returns the latest persisted RegionalSnapshot for a region. The snapshot is written every 6h by scripts/seed-regional-snapshots.mjs; this handler only reads canonical state. Premium-gated. PRO-gated. Requires an active Pro subscription. operationId: GetRegionalSnapshot parameters: - name: region_id in: query description: >- Display region id (e.g. "mena", "east-asia", "europe"). See shared/geography.js. Kebab-case: lowercase alphanumeric groups separated by single hyphens, no trailing or consecutive hyphens. required: true example: mena schema: type: string pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$ - 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: snapshot: actors: - actorId: example-id delta: 1.5 evidenceIds: - example leverageDomains: - example leverageScore: 42.5 balance: allianceCohesion: 1.5 buffers: - axis: example description: Example WorldMonitor observation. evidenceIds: - example magnitude: 1.5 orientation: example capitalStress: 1.5 coercivePressure: 1.5 domesticFragility: 1.5 evidence: - confidence: 0.82 corridor: example id: example-id observedAt: 1717200000000 source: example generatedAt: 1717200000000 leverageEdges: - evidenceIds: - example fromActorId: example-id mechanism: example strength: 1.5 toActorId: example-id schema: $ref: '#/components/schemas/GetRegionalSnapshotResponse' '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 subscription required. 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' security: - WorldMonitorKey: [] - ApiKeyHeader: [] - BearerAuth: [] components: schemas: GetRegionalSnapshotResponse: type: object properties: snapshot: $ref: '#/components/schemas/RegionalSnapshot' description: |- GetRegionalSnapshotResponse returns the latest RegionalSnapshot for the requested region. The snapshot is written by scripts/seed-regional-snapshots.mjs on a 6h cron; this handler only reads canonical state. 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 RegionalSnapshot: type: object properties: regionId: type: string generatedAt: type: integer format: int64 description: 'Warning: Values > 2^53 may lose precision in JavaScript' meta: $ref: '#/components/schemas/SnapshotMeta' regime: $ref: '#/components/schemas/RegimeState' balance: $ref: '#/components/schemas/BalanceVector' actors: type: array items: $ref: '#/components/schemas/ActorState' leverageEdges: type: array items: $ref: '#/components/schemas/LeverageEdge' scenarioSets: type: array items: $ref: '#/components/schemas/ScenarioSet' transmissionPaths: type: array items: $ref: '#/components/schemas/TransmissionPath' triggers: $ref: '#/components/schemas/TriggerLadder' mobility: $ref: '#/components/schemas/MobilityState' evidence: type: array items: $ref: '#/components/schemas/EvidenceItem' narrative: $ref: '#/components/schemas/RegionalNarrative' description: |- RegionalSnapshot is the canonical intelligence object for one region. See docs/internal/pro-regional-intelligence-upgrade.md for the full spec and shared/regions.types.d.ts for the authoritative TypeScript contract. 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. SnapshotMeta: type: object properties: snapshotId: type: string modelVersion: type: string scoringVersion: type: string geographyVersion: type: string snapshotConfidence: type: number format: double missingInputs: type: array items: type: string staleInputs: type: array items: type: string validUntil: type: integer format: int64 description: 'Warning: Values > 2^53 may lose precision in JavaScript' triggerReason: type: string description: |- trigger_reason: scheduled_6h | regime_shift | trigger_activation | corridor_break | leverage_shift narrativeProvider: type: string narrativeModel: type: string description: >- SnapshotMeta carries the trust trail (versions, confidence, input freshness, narrative provenance, idempotency id). RegimeState: type: object properties: label: type: string description: |- label: calm | stressed_equilibrium | coercive_stalemate | fragmentation_risk | managed_deescalation | escalation_ladder previousLabel: type: string transitionedAt: type: integer format: int64 description: 'Warning: Values > 2^53 may lose precision in JavaScript' transitionDriver: type: string description: RegimeState captures the current regime label and transition history. BalanceVector: type: object properties: coercivePressure: type: number format: double description: Pressures (high = bad) domesticFragility: type: number format: double capitalStress: type: number format: double energyVulnerability: type: number format: double allianceCohesion: type: number format: double description: Buffers (high = good) maritimeAccess: type: number format: double energyLeverage: type: number format: double netBalance: type: number format: double description: 'Derived: mean(buffers) - mean(pressures), range [-1, +1]' pressures: type: array items: $ref: '#/components/schemas/BalanceDriver' buffers: type: array items: $ref: '#/components/schemas/BalanceDriver' description: >- BalanceVector is the 7-axis regional balance score with pressures/buffers split. See docs/internal/pro-regional-intelligence-appendix-scoring.md for the per-axis formulas. ActorState: type: object properties: actorId: type: string name: type: string role: type: string description: 'role: aggressor | stabilizer | swing | broker' leverageDomains: type: array items: type: string description: >- leverage_domains: energy | military | diplomatic | economic | maritime leverageScore: type: number format: double delta: type: number format: double evidenceIds: type: array items: type: string description: ActorState is one geopolitical actor's leverage score in the region. LeverageEdge: type: object properties: fromActorId: type: string toActorId: type: string mechanism: type: string description: >- mechanism: sanctions | naval_posture | energy_supply | alliance_shift | trade_friction strength: type: number format: double evidenceIds: type: array items: type: string description: LeverageEdge is a directed influence relationship between two actors. ScenarioSet: type: object properties: horizon: type: string description: 'horizon: 24h | 7d | 30d' lanes: type: array items: $ref: '#/components/schemas/ScenarioLane' description: >- ScenarioSet bundles scenario lanes for one time horizon. Lane probabilities sum to 1.0 within a set. TransmissionPath: type: object properties: start: type: string mechanism: type: string end: type: string severity: type: string description: 'severity: critical | high | medium | low' corridorId: type: string confidence: type: number format: double latencyHours: type: integer format: int32 impactedAssetClass: type: string description: >- impacted_asset_class: crude | lng | container | fx | equity | agri | metals | ... impactedRegions: type: array items: type: string magnitudeLow: type: number format: double magnitudeHigh: type: number format: double magnitudeUnit: type: string description: 'magnitude_unit: usd_bbl | pct | usd_teu | basis_points | ...' templateId: type: string templateVersion: type: string description: |- TransmissionPath describes how a regional event propagates to markets, logistics, mobility, or other domains. Typed for ranking and calibration. TriggerLadder: type: object properties: active: type: array items: $ref: '#/components/schemas/Trigger' watching: type: array items: $ref: '#/components/schemas/Trigger' dormant: type: array items: $ref: '#/components/schemas/Trigger' description: TriggerLadder buckets triggers by activation state. MobilityState: type: object properties: airspace: type: array items: $ref: '#/components/schemas/AirspaceStatus' flightCorridors: type: array items: $ref: '#/components/schemas/FlightCorridorStress' airports: type: array items: $ref: '#/components/schemas/AirportNodeStatus' rerouteIntensity: type: number format: double notamClosures: type: array items: type: string description: >- MobilityState captures airspace, flight corridor, and airport node status for the region. Phase 0 ships empty; Phase 2 wires the data plane. EvidenceItem: type: object properties: id: type: string type: type: string description: |- type: vessel_track | flight_surge | news_headline | cii_spike | chokepoint_status | sanctions_move | market_signal | mobility_disruption source: type: string description: 'source: AIS | ADSB | GDELT | ACLED | Yahoo | OREF | NOTAM | ...' summary: type: string confidence: type: number format: double observedAt: type: integer format: int64 description: 'Warning: Values > 2^53 may lose precision in JavaScript' theater: type: string corridor: type: string description: |- EvidenceItem is one upstream data point linked from balance drivers, narrative sections, and triggers. RegionalNarrative: type: object properties: situation: $ref: '#/components/schemas/NarrativeSection' balanceAssessment: $ref: '#/components/schemas/NarrativeSection' outlook24h: $ref: '#/components/schemas/NarrativeSection' outlook7d: $ref: '#/components/schemas/NarrativeSection' outlook30d: $ref: '#/components/schemas/NarrativeSection' watchItems: type: array items: $ref: '#/components/schemas/NarrativeSection' description: |- RegionalNarrative is the LLM-synthesized narrative layer. Every section links back to evidence via evidence_ids. BalanceDriver: type: object properties: axis: type: string description: type: string magnitude: type: number format: double evidenceIds: type: array items: type: string orientation: type: string description: 'orientation: "pressure" | "buffer"' description: >- BalanceDriver is one contributor to an axis score. Links back to evidence. ScenarioLane: type: object properties: name: type: string description: 'name: base | escalation | containment | fragmentation' probability: type: number format: double triggerIds: type: array items: type: string consequences: type: array items: type: string transmissions: type: array items: $ref: '#/components/schemas/TransmissionPath' description: ScenarioLane is one outcome branch within a horizon set. Trigger: type: object properties: id: type: string description: type: string threshold: $ref: '#/components/schemas/TriggerThreshold' activated: type: boolean activatedAt: type: integer format: int64 description: 'Warning: Values > 2^53 may lose precision in JavaScript' scenarioLane: type: string description: 'scenario_lane: base | escalation | containment | fragmentation' evidenceIds: type: array items: type: string description: Trigger is a structured threshold assertion against a named metric. AirspaceStatus: type: object properties: airspaceId: type: string status: type: string description: 'status: open | restricted | closed' reason: type: string description: AirspaceStatus captures FIR-level airspace state. FlightCorridorStress: type: object properties: corridor: type: string stressLevel: type: number format: double reroutedFlights24h: type: integer format: int32 description: FlightCorridorStress captures per-corridor reroute intensity. AirportNodeStatus: type: object properties: icao: type: string name: type: string status: type: string description: 'status: normal | disrupted | closed' disruptionReason: type: string description: AirportNodeStatus captures airport-level disruption state. NarrativeSection: type: object properties: text: type: string evidenceIds: type: array items: type: string description: >- NarrativeSection is one block of narrative text plus its supporting evidence. TriggerThreshold: type: object properties: metric: type: string operator: type: string description: 'operator: gt | gte | lt | lte | delta_gt | delta_lt' value: type: number format: double windowMinutes: type: integer format: int32 baseline: type: string description: 'baseline: trailing_7d | trailing_30d | fixed' description: |- TriggerThreshold defines the metric/operator/value/window/baseline for deterministic trigger evaluation. 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 . ````