Map details

This API endpoint retrieves comprehensive details of a VPS map by providing its unique map code in the URL path along with a bearer token for authentication, returning complete information including the map's status, geographic location, spatial metrics (floor areas, elevations, capture points), storage usage, etc.

hasPano tells you whether the map has a 360° virtual tour. When it is true, you can load the tour with the 360° Virtual Tour (Pano) APIs. If the map belongs to a Map Version, the response also carries versionCode and activeMapCode. See Map Versioning for how to apply them at runtime.

Get a VPS map by code

get

Authorizations

AuthorizationstringRequired

JWT token obtained from the authentication endpoint.

Path parameters

mapCodestringRequired

Unique map code identifier.

Example: MAP_BTTE1MOXYVT8Pattern: ^MAP_[A-Z0-9]+$

Responses

200

The requested map.

application/json

_idstringOptional

Unique identifier.

accountIdstringOptional

Account that owns the map.

mapNamestringOptional

Human-readable name.

mapCodestringOptional

Unique code identifier.

statusstring · enumOptional

Processing status.

Possible values:

headingnumber · max: 360 · nullableOptional

Map orientation in degrees.

storagenumberOptional

Storage size in bytes.

thumbnailstring · uri · nullableOptional

Thumbnail image URL.

offlineBundleStatusstring · enum · nullableOptional

Offline bundle status.

Possible values:

offlineBundlestring · uri · nullableOptional

Offline bundle download URL.

hasPanobooleanOptional

Whether this map has a 360° virtual tour. See the 360 Virtual Tour (Pano) API.

versionCodestring · nullableOptional

Map Version code, present when this map belongs to a version.

activeMapCodestring · nullableOptional

The currently active map in the version, present when this map is versioned.

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

400

Bad Request. Invalid map code format.

401

Unauthorized. Invalid or expired token.

404

Map not found.

get/vps/map/{mapCode}

GET /v1/vps/map/{mapCode} HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "accountId": "text",
  "mapName": "text",
  "mapCode": "text",
  "status": "uploading",
  "location": {
    "type": "Point",
    "coordinates": [
      1
    ]
  },
  "heading": 1,
  "storage": 1,
  "thumbnail": "https://example.com",
  "offlineBundleStatus": "processing",
  "offlineBundle": "https://example.com",
  "spatialMetrics": {
    "total_area_sqm": 1,
    "num_floors": 1,
    "floors": [
      {
        "floor_id": "text",
        "elevation": 1,
        "area_sqm": 1,
        "num_captures": 1,
        "bounds": {}
      }
    ]
  },
  "hasPano": true,
  "versionCode": "text",
  "activeMapCode": "text",
  "generation": {
    "version": "gen2",
    "status": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

GET All VPS maps for an account

limit and page are both required on this endpoint. A request without them, such as GET /vps/map, returns 500 with {"error": "Something went wrong!"}. Use GET /vps/map?limit=10&page=1 to fetch the first page.

Get all VPS maps

get

Retrieves a paginated list of VPS maps using limit and page parameters.

Both limit and page are required. Omitting either one returns a 500 error.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · min: 1 · max: 100Required

Number of items to return per page. Required.

Example: 10

pageinteger · min: 1Required

Page number for pagination. Required.

Example: 1

Responses

200

VPS maps retrieved successfully

application/json

401

Unauthorized

application/json

500

Server error, returned when limit or page is missing

application/json

get/vps/map

GET /v1/vps/map?limit=10&page=1 HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "66ca3f3b773b18f09e131279",
      "name": "Office Building Map",
      "description": "3D map of the main office building",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "status": "active"
    }
  ],
  "pagination": {
    "totalItems": 45,
    "totalPages": 5,
    "currentPage": 1,
    "itemsPerPage": 10
  }
}

Get paginated list of MapSets

get

Retrieves a paginated list of MapSets associated with the authenticated user's account

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · min: 1 · max: 100Optional

Number of items to return per page

Default: 10Example: 10

pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1

Responses

200

MapSets retrieved successfully

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized

application/json

500

Internal Server Error - Something went wrong on the server

application/json

get/vps/map-set

GET /v1/vps/map-set HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "66ca3f3b773b18f09e131280",
      "name": "Office Buildings Collection",
      "description": "Collection of office building maps",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "status": "active",
      "mapCount": 3
    }
  ],
  "pagination": {
    "totalItems": 12,
    "totalPages": 2,
    "currentPage": 1,
    "itemsPerPage": 10
  }
}