REST API Docs

You can use our REST API to fetch and query your VPS Maps to get device Pose with respect to Map local origin, the query API takes query image (encoded as base64 string) and other image metadata.

M2M Auth

Generate a token for an M2M client

Authenticates a machine-to-machine client using Basic Authentication and returns an access token. The Basic Auth value should be constructed as: Base64(clientId:clientSecret)

POSThttps://api.multiset.ai/v1/m2m/token

Authorization

basicAuth

Header parameters

Body

text/plain

string

Example: ""

Response

200400401403

Token generated successfully

Body

application/json

token*string

JWT token for authentication

Example: "eyJhbGciOiJIUzI1NiIsInR5cC......."

expiresOn*string (date-time)

Token expiration timestamp in ISO 8601 format

Example: "2024-10-22T18:40:54.908Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.multiset.ai/v1/m2m/token', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Username": "text",
      "Password": "text",
      "Content-Type": "text/plain"
    },
});
const data = await response.json();

Response

200400401403

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cC.......",
  "expiresOn": "2024-10-22T18:40:54.908Z"
}

GET All VPS maps for an account

Get all VPS maps

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

GEThttps://api.multiset.ai/v1/vps/map

Authorization

bearerAuth

Query parameters

Response

200401

VPS maps retrieved successfully

Body

application/json

data*array of object

Array of VPS maps

pagination*object

Pagination information

Request

JavaScriptCurlPython

const response = await fetch('https://api.multiset.ai/v1/vps/map', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401

{
  "data": [
    {
      "mapCode": "MAP-X2P23E7Q35VD",
      "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
  }
}

VPS Query API

Query your map to get the device position with respect to Map local origin, the query API takes query image (encoded as base64 string) and other image metadata

Query a VPS map with specific parameters

POSThttps://api.mulitset.ai/v1/vps/map/query

Authorization

bearerAuth

Body

application/json

mapCodestring

Unique identifier for the VPS map

Example: "MAP-X2P23E7Q35VD"

cameraIntrinsics*object

Camera intrinsic parameters

isRightHandedboolean

Flag to indicate if response pose is in right-handed coordinate system

Example: false

resolutionobject

Image resolution parameters

queryImage*string (base64)

Base64 encoded image data

Example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA8AAAALQCAIAAADQFY7jAAAgAElEQVR4AaS9+5NdR5Lfh34BjW4AxJMgOTN8zCw5OzHriV2vvFrZDjtCVki2Xt5VaKVdybLClsL+3xz23+DQr9ZPlmO16xmvh"

Response

200400401

Query successful

Body

application/json

poseFound*boolean

Indicates if the pose was successfully found

Example: true

position*object

3D position coordinates

rotation*object

Quaternion rotation

confidence*number

Confidence score of the pose estimation

Example: 0.459232334365416

Request

JavaScriptCurlPython

const response = await fetch('https://api.mulitset.ai/v1/vps/map/query', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cameraIntrinsics": {
        "fx": 664.3856201171875,
        "fy": 664.3856201171875,
        "px": 478.9782409667969,
        "py": 364.9932861328125
      },
      "queryImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA8AAAALQCAIAAADQFY7jAAAgAElEQVR4AaS9+5NdR5Lfh34BjW4AxJMgOTN8zCw5OzHriV2vvFrZDjtCVki2Xt5VaKVdybLClsL+3xz23+DQr9ZPlmO16xmvh"
    }),
});
const data = await response.json();

Response

200400401

{
  "poseFound": true,
  "position": {
    "x": 2.482360321597187,
    "y": 0.11936171927197065,
    "z": 8.06609995252609
  },
  "rotation": {
    "x": 0.02949315565629783,
    "y": 0.7673793569590026,
    "z": -0.01740867960782986,
    "w": 0.6402780756491143
  },
  "confidence": 0.459232334365416
}

VPS Query Form API

Query a VPS map or mapset using form-data

POSThttps://api.multiset.ai/v1/vps/map/query-form

Authorization

bearerAuth

Body

multipart/form-data

mapCodestring

The map code for the map to query (required if mapSetCode is not provided)

mapSetCodestring

The map set code for the map set to query (required if mapCode is not provided)

isRightHandedenum

Example: "true"

truefalse

fx*string

Example: "669.535888671875"

fy*string

Example: "669.535888671875"

px*string

Example: "478.8777160644531"

py*string

Example: "364.9244079589844"

width*string

Example: "960"

height*string

Example: "720"

queryImage*string (binary)

Image file for multipart requests

Response

200400401

Query successful

Body

application/json

object

Successful query response (structure to be defined)

Request

JavaScriptCurlPython

const response = await fetch('https://api.multiset.ai/v1/vps/map/query-form', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "fx": "669.535888671875",
      "fy": "669.535888671875",
      "px": "478.8777160644531",
      "py": "364.9244079589844",
      "width": "960",
      "height": "720",
      "queryImage": "binary"
    }),
});
const data = await response.json();

Response

400401

{
  "error": "Invalid parameters"
}

File download API

Retrieve a pre-signed S3 URL for file download

Generates a temporary, pre-signed URL for downloading a file from S3

GEThttps://api.multiset.ai/v1/file

Query parameters

Response

200401404500

Successfully generated pre-signed URL

Body

application/json

url*string

Pre-signed S3 URL for file download

Example: "https://amazonaws.com/671bX-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=%2Faws4_request&X-Amz-Date=20241658753a8c6380ad6d01c217e1ad978d88e2ba6a4&X-Amz-SignedHeaders=host&x-id=GetObject"

Request

JavaScriptCurlPython

const response = await fetch('https://api.multiset.ai/v1/file?key=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "url": "https://amazonaws.com/671bX-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=%2Faws4_request&X-Amz-Date=20241658753a8c6380ad6d01c217e1ad978d88e2ba6a4&X-Amz-SignedHeaders=host&x-id=GetObject"
}