ModelSet Query

ModelSet Query API

objectCode can be a single string or an array of strings, pass multiple object codes in case of tracking multiple objects in the same session

ModelSet Query API

post

Query a VPS object using an uploaded image and camera parameters. Accepts objectCode to identify the target object, and returns the query result from the external API.

Authorizations

bearerAuth

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

multipart/form-data

objectCodestringRequired

The code of the VPS object

Example: OBJ-001

fxstringRequired

Camera intrinsic parameter fx (focal length x-axis)

Example: 1000.0

fystringRequired

Camera intrinsic parameter fy (focal length y-axis)

Example: 1000.0

pxstringRequired

Camera intrinsic parameter px (principal point x-coordinate)

Example: 640.0

pystringRequired

Camera intrinsic parameter py (principal point y-coordinate)

Example: 480.0

isRightHandedstring · enumRequired

Specifies whether the coordinate system is right-handed. Because this is form-data, it's sent as a string ("true" or "false").

Example: truePossible values:

widthstringRequired

The width (in pixels) of the input image

Example: 1280

heightstringRequired

The height (in pixels) of the input image

Example: 720

queryImagestring · binaryRequired

The image file to query against the object

Responses

200

Query successful

application/json

400

Bad request - Invalid parameters or missing required fields

application/json

401

Unauthorized - Missing or invalid token

application/json

403

Forbidden - Access denied

application/json

404

Object not found

application/json

500

Internal server error

application/json

post

/vps/object/query

HTTPcURLJavaScriptPython

POST /v1/vps/object/query HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 153

{
  "objectCode": "OBJ-001",
  "fx": "1000.0",
  "fy": "1000.0",
  "px": "640.0",
  "py": "480.0",
  "isRightHanded": "true",
  "width": "1280",
  "height": "720",
  "queryImage": "binary"
}

{
  "success": true,
  "result": {
    "position": {
      "x": 2.1234,
      "y": 1.5678,
      "z": 0.9876
    },
    "rotation": {
      "qx": 0.0123,
      "qy": 0.4567,
      "qz": 0.0789,
      "qw": 0.8901
    },
    "confidence": 0.92
  },
  "message": "Query successful."
}

Get a paginated list of VPS objects

get

Retrieves a paginated list of VPS objects. You can use query parameters to filter or search objects by name, and control pagination settings.

Authorizations

bearerAuth

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Query parameters

pageinteger · min: 1Optional

The page number for pagination (starting from 1)

Default: 1Example: 1

limitinteger · min: 1 · max: 100Optional

Number of records per page (maximum 100)

Default: 10Example: 10

querystring · max: 255Optional

Filter or search text for partial match on object names

Example: Multiset

Responses

200

A paginated list of VPS objects retrieved successfully

application/json

400

Bad request - Invalid query parameters

application/json

401

Unauthorized - Missing or invalid token

application/json

500

Internal server error

application/json

get

/vps/object

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "_id": "67a5b08736cb3f76aaf3a416",
      "objectName": "Multiset Object 1",
      "trackingType": "side",
      "source": {
        "provider": "web",
        "fileType": "glb",
        "coordinateSystem": "RHS"
      }
    },
    {
      "_id": "67a5b08736cb3f76aaf3a417",
      "objectName": "Multiset Object 2",
      "trackingType": "top",
      "source": {
        "provider": "mobile",
        "fileType": "obj",
        "coordinateSystem": "LHS"
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 5,
  "totalCount": 42
}