ModelSet Upload

To create a new ModelSet using the upload API, make a POST request to /v1/vps/object with your authentication token, providing the object name, tracking type (full for 360-degree tracking or side for side-view only), and source details including the file type (glb or gltf), provider (web), and coordinate system (RHS for right-handed or LHS for left-handed).

The API will respond with a pre-signed S3 upload URL, unique object ID, and object code. Use the returned uploadUrl to upload your 3D model file directly to S3 via a PUT request with Content-Type: application/octet-stream. Once uploaded, the system will automatically process the model for Object tracking.

Create a new ModelSet object

post

Creates a new ModelSet object and returns a pre-signed URL for uploading the 3D model file. The model file should be uploaded to the returned uploadUrl using a PUT request.

Workflow:

  1. Call this endpoint to create the object and get an upload URL

  2. Upload the model file (.glb or .gltf) to the uploadUrl using PUT request with Content-Type: application/octet-stream

  3. The system will process the uploaded file for VPS tracking

Authorizations
AuthorizationstringRequired

JWT token obtained from authentication

Body
objectNamestring · min: 1 · max: 255Required

Name of the ModelSet object

Example: Product Demo Model
trackingTypestring · enumRequired

Type of tracking to be performed:

  • full: 360-degree tracking (all angles)
  • side: Side-view tracking only
Example: fullPossible values:
Responses
200

ModelSet object created successfully

application/json
post
/v1/vps/object

Last updated

Was this helpful?