Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

world4-api

FastAPI service that exposes the world4-core engine over HTTP, so the web dashboard (and later a Godot client) can drive the same model.

uv run world4-api          # serves on http://127.0.0.1:8537  (docs at /docs)

It defaults to port 8537 (8000 is often reserved/forwarded on Windows) and auto-loads the local artifacts data/models/exiobase_2022_pxp.npz and data/labor/labor_inputs_2022.json if present (else the synthetic test model). Override with WORLD4_API_PORT, WORLD4_MODEL_PATH, WORLD4_LABOR_PATH.

Endpoints:

Method Path Purpose
GET /health Liveness probe.
GET /model/info Model dimensions (regions, sectors, extensions).
POST /scenario Run a Scenario, get a ScenarioResult.

CORS is off by default. To allow a browser front-end, set WORLD4_CORS_ORIGINS (comma-separated origins), e.g. WORLD4_CORS_ORIGINS=http://localhost:5173.