Site Models

Endpoint

GET /api/v1/sites/{siteId}/models

List 3D model files (IFC, fragments, GLB, OBJ) uploaded to a site. Use this to populate a 3D viewer with the correct model files for a building.

Pair this endpoint with the entityByIfcId GraphQL query to enable click-to-data in 3D viewers. Load models from this endpoint, then look up clicked IFC elements in the knowledge graph.

Path parameters

Parameter	Type	Description
`siteId`	`string`	Site ID

Query parameters

Parameter	Type	Description
`file_format`	`string`	Filter by format: `ifc`, `frag`, `glb`, `obj`
`storey`	`string`	Filter by storey name (exact match)

Response

Returns an array of model objects:

Field	Type	Description
`id`	`uuid`	Model file ID
`name`	`string`	File display name
`format`	`string`	File format (`ifc`, `frag`, `glb`, `obj`)
`storey`	`string`	Storey name, if applicable
`sort_order`	`integer`	Display order hint (0 = first)
`size_bytes`	`integer`	File size in bytes
`download_url`	`string`	Path to download the file
`created_at`	`datetime`	Upload timestamp (ISO-8601)
`source_ifc`	`uuid \| null`	ID of the source IFC file (for fragment files)

Download

GET /api/v1/sites/{siteId}/models/{modelId}/download

Returns the raw file as a binary download with Content-Disposition: attachment.

Status codes

Code	Description
`200`	Success
`400`	Invalid `file_format` value
`401`	Not authenticated
`404`	Site or model not found
`429`	Rate limit exceeded

Examples

List all models for a site

curl https://app.betacit.com/api/v1/sites/ucl-east/models/ \
  -H "Authorization: Bearer your-api-key"

Response

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "UCL East Ground Floor",
    "format": "glb",
    "storey": "Ground Floor",
    "sort_order": 0,
    "size_bytes": 4521984,
    "download_url": "/api/v1/sites/ucl-east/models/a1b2c3d4-e5f6-7890-abcd-ef1234567890/download",
    "created_at": "2026-02-28T10:30:00Z",
    "source_ifc": null
  },
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "UCL East Building.ifc",
    "format": "ifc",
    "storey": "",
    "sort_order": 0,
    "size_bytes": 52428800,
    "download_url": "/api/v1/sites/ucl-east/models/b2c3d4e5-f6a7-8901-bcde-f12345678901/download",
    "created_at": "2026-02-28T10:00:00Z",
    "source_ifc": null
  }
]

Filter by format

curl "https://app.betacit.com/api/v1/sites/ucl-east/models/?file_format=glb" \
  -H "Authorization: Bearer your-api-key"

Filter by storey

curl "https://app.betacit.com/api/v1/sites/ucl-east/models/?storey=Ground+Floor" \
  -H "Authorization: Bearer your-api-key"

Download a model file

curl -O https://app.betacit.com/api/v1/sites/ucl-east/models/a1b2c3d4-e5f6-7890-abcd-ef1234567890/download \
  -H "Authorization: Bearer your-api-key"

GraphQL

REST API

REST guides

Endpoint

Path parameters

Query parameters

Response

Download

Status codes

Examples

List all models for a site

Filter by format

Filter by storey

Download a model file

​Endpoint

​Path parameters

​Query parameters

​Response

​Download

​Status codes

​Examples

​List all models for a site

​Filter by format

​Filter by storey

​Download a model file

Endpoint

Path parameters

Query parameters

Response

Download

Status codes

Examples

List all models for a site

Filter by format

Filter by storey

Download a model file