MODEL API
https://api.approach.no/api/v1/predictions · OpenAPI contract
Models with an active Datakilde release: card, method, tier, sources, limitations, input and output schema.
Takes no parameters.
| HTTP | Meaning | Codes in the body |
|---|---|---|
| 200 | Model catalogue | — |
| 503 | prediction_service_unavailable |
One model's release card and schemas.
| Name | Type | Bounds and default | Description |
|---|---|---|---|
| model path · required | string | — | — |
| HTTP | Meaning | Codes in the body |
|---|---|---|
| 200 | Model | — |
| 404 | model_not_found | |
| 503 | prediction_service_unavailable |
Run a served model for one subject. One oppslag per model and subject per day on the lookup allowance; repeats the same day are free, and an abstention or a failure is never counted. The grant must name the model (models capability). The answer names the release that produced it.
| Name | Type | Bounds and default | Description |
|---|---|---|---|
| model body · required | string | ^[a-z][a-z0-9_]{2,62}$ | A model id from /catalog |
| options body | object | — | Model-specific; see the model's input_schema |
| subject body · required | object | — | An address id, or a point in EPSG:25833 inside Norway. |
| version body | string | — | Optional: the release version you expect. Refused if it is not the active one, so a pinned client notices a new release. |
| HTTP | Meaning | Codes in the body |
|---|---|---|
| 200 | Prediction | — |
| 400 | invalid_prediction_request | |
| 401 | Authentication required | |
| 402 | Allowance exhausted | |
| 403 | address_endpoint_not_allowed (no models capability) or model_not_granted |
|
| 404 | model_not_found or prediction_subject_not_found | |
| 413 | prediction_request_too_large | |
| 429 | Rate limit exceeded | |
| 500 | — | |
| 503 | prediction_capacity_exhausted or prediction_service_unavailable; nothing counted. Retry with backoff after Retry-After seconds. | |
| 504 | prediction_timeout |
Which models are available depends on which releases are active; /catalog lists them with method, sources, limitations and schemas.
| Id | Title and source | Details |
|---|