API integration
Each deployed model is a REST call you put in an application, a website, a data pipeline, or an internal portal. Every call sends X-api-key and X-username. X-username is the username on the Heimdall account. ML, Forecast, Loop, and Resolve also send the id of that asset.
| Product | Host | Extra header | Key |
|---|---|---|---|
| ML | https://predict.heimdallapp.org/predict/ | x-model-id | Model page, shown once |
| Forecast | https://predict.heimdallapp.org/forecast/ | x-forecast-id | Forecast page, shown once |
| Loop predict | https://loop.heimdallapp.org/predict/ | x-loop-id | Loop page, shown once |
| Loop train | https://loop.heimdallapp.org/train/ | x-loop-id | Same loop key |
| Resolve | https://predict.heimdallapp.org/resolve/ | X-resolve-id | API tab → Enable API |
| Read | https://read.heimdallapp.org/read/v1/api/process | none | Account → API keys |
| Vision | https://vision.heimdallapp.org/vision/v1/api/process | none | Same unstructured key |
The API Integration tab on an ML, Forecast, or Loop page shows a sample with your username and that asset's id. Resolve uses the API tab. The sample is the contract. The guides below match it.