MatterPak Upload API

The VPS Map Creation API accepts a POST request to /v1/vps/map with a JSON payload containing map metadata and Matterport authentication.

Create a VPS Map using MatterPak

post

https://api.multiset.aihttps://dev-api.multiset.ai

/v1/vps/map

Creates a new VPS map from a Matterport space using MatterPak.

Authentication Options: You can authenticate with Matterport using one of two methods:

1. OAuth Token: Use oauthToken in the metadata

2. Client Credentials: Use both clientId and clientSecret in the metadata

Process Flow:

1. Submit map creation request with Matterport space ID and credentials

2. System fetches the MatterPak from Matterport using provided credentials

3. Map is processed in the cloud (no file upload required)

4. Map becomes available for VPS queries when processing completes

Note: The map name will be automatically truncated to 30 characters if longer.

Authorizations

bearerAuth

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme.

You can obtain a bearer token by:

1. Authenticating through /v1/auth/login endpoint
2. Using M2M (Machine-to-Machine) credentials via /v1/m2m/token endpoint

Example: "Authorization: Bearer {your-jwt-token}"

Body

application/json

mapNamestring · min: 3 · max: 255Required

Name of the VPS map (will be truncated to 30 characters if longer). Should be descriptive and unique to help identify the map.

Example: Office Building - Floor 1

headingnumber · double · max: 360Optional

Optional heading/orientation in degrees (0-360)

Example: 90

Responses

201

Map creation request submitted successfully

application/json

400

Bad request - Invalid parameters

application/json

401

Unauthorized - Missing or invalid authentication token

application/json

403

Forbidden - Matterport authentication failed

application/json

500

Internal server error

application/json

post

/v1/vps/map

HTTPcURLJavaScriptPython

POST /v1/vps/map HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "mapName": "Office Building - Floor 1",
  "coordinates": {
    "latitude": 37.7749,
    "longitude": -122.4194,
    "altitude": 10.5
  },
  "heading": 90,
  "source": {
    "provider": "matterport",
    "fileType": "matterpak",
    "coordinateSystem": "RHS",
    "processType": "cloud",
    "metadata": {
      "spaceId": "abc123def456",
      "clientId": "your-matterport-client-id",
      "clientSecret": "your-matterport-client-secret"
    }
  }
}

Using Client ID and SecretUsing OAuth Token

{
  "message": "Map created successfully",
  "mapId": "67a5b08736cb3f76aaf3a416",
  "status": "processing",
  "mapName": "Office Building - Floor 1",
  "estimatedProcessingTime": "10-30 minutes"
}