REST API Docs
Last updated
Was this helpful?
Last updated
Was this helpful?
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.
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
Get the list of all Mapsets in an account
Get details of all maps of a specific Mapset using MapSetID
Unique identifier for the VPS map
MAP-X2P23E7Q35VDFlag to indicate if response pose is in right-handed coordinate system
falseBase64 encoded image data
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA8AAAALQCAIAAADQFY7jAAAgAElEQVR4AaS9+5NdR5Lfh34BjW4AxJMgOTN8zCw5OzHriV2vvFrZDjtCVki2Xt5VaKVdybLClsL+3xz23+DQr9ZPlmO16xmvhGenerates a temporary, pre-signed URL for downloading a file from S3
Unique identifier for the file
671b454e33d6dc761ca15156/6756c20336a9794c6effce42/Mesh/TexturedMesh.glbRetrieves a paginated list of VPS maps using limit and page parameters
Number of items to return per page
10Example: 10Page number for pagination
1Example: 1Retrieves a paginated list of MapSets associated with the authenticated user's account
Number of items to return per page
10Example: 10Page number for pagination
1Example: 1Fetches details of a specific map set using its unique ID.
The unique ID of the map set.
67a5c7fca18f6052c5b21653The map code for the map to query (required if mapSetCode is not provided)
The map set code for the map set to query (required if mapCode is not provided)
truePossible values: 669.535888671875669.535888671875478.8777160644531364.9244079589844960720Image file for multipart requests
Successful query response (structure to be defined)
Performs a query using one or more uploaded images, along with camera intrinsics and optional map or map-set identifiers. Supports up to four images in a single request.
Specifies whether the coordinate system is right-handed. Because this is form-data, it's sent as a string ("true" or "false").
truePossible values: The width (in pixels) of the input image(s).
960The height (in pixels) of the input image(s).
720The principal point x-coordinate.
478.838623046875The principal point y-coordinate.
365.346618652343The focal length along x-axis.
670.4620971679688The focal length along y-axis.
670.4620971679688ID of the specific map.
Code to identify the map.
A unique ID for the map set.
A code to identify the map set.
The first image file to be uploaded.
JSON-encoded metadata for image1 (e.g., position and rotation).
{"x":-5.1772,"y":0.2936,"z":-2.6439,"qx":-0.0185,"qy":0.9949,"qz":-0.0691,"qw":0.0703}The second image file to be uploaded.
JSON-encoded metadata for image2.
{"x":-3.12,"y":1.01,"z":2.56,"qx":0.0,"qy":0.707,"qz":0.0,"qw":0.707}The third image file to be uploaded.
JSON-encoded metadata for image3.
{"x":1.23,"y":-0.56,"z":5.0,"qx":-0.0185,"qy":0.9949,"qz":-0.0691,"qw":0.0703}The fourth image file to be uploaded.
JSON-encoded metadata for image4.
{"x":10.0,"y":-2.0,"z":0.0,"qx":0.0,"qy":1.0,"qz":0.0,"qw":0.0}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)
Client ID for authentication
Client Secret for authentication
Basic authentication header. Format: "Basic " + Base64(clientId:clientSecret)
Basic dXNlcm5hbWU6cGFzc3dvcmQ=