Download one artifact of a building model through RES

Streams model.obj, model.glb, model.city.json, model.dxf, model.mtl, manifest.json or model_package.zip for a buildingId returned by POST /res_api/3d/building_model. Sent with Content-Disposition: attachment. 404 until the model has been generated. Accepts ?token= so the URL works from a plain link or a Grasshopper HTTP fetch.

GET

https://res.aireon.ch/res_api/3d/building_model/file/{buildingId}/{file}

Authorization

ResApiToken
optional
API key in header

ResApiTokenQuery
optional
API key in query

Path parameters

buildingId
string
required
pattern: ^[a-f0-9]{64}$
file
model.obj
or
model.glb
or
model.city.json
or
model.dxf
or
model.mtl
or
manifest.json
+1 more
required

Query parameters

token
optional
string

Returns

200

The artifact bytes (Content-Type as served by the 3D service: text/plain for OBJ, model/gltf-binary for GLB, application/json for CityJSON, application/zip for the package).

400

Invalid request.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

401

Authentication missing or invalid.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

403

Authenticated but not permitted.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

404

Resource not found.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

502

The 3D service is unreachable or answered with an error (its status and body are relayed in upstream_status / upstream).

JSON

error
optional
string
upstream_status
optional
integer
upstream
optional
unknown
detail
optional
string

504

The 3D service did not answer within the proxy timeout.

JSON

error
optional
string
detail
optional
string