API endpoints

List of currently available endpoints and methods

All endpoints require the Accept header to specify the version using v=1 Accept: application/json;v=1

Endpoint
Method
Description

/users

GET, POST, PATCH

Register new users to be scanned. List/Update existing users.

/scans

GET, POST

Create a new scan entry, necessary for any new scan. Check scan status.

/scans/{scanId}/upload-url

POST

Create a short-lived URL to upload scan camera data.

/scans/{scanId}/body

GET, POST

Check status of the generation of the original 3D body model asset.

/scans/{scanId}/body/download-url

POST

Create a short-lived URL from where a 3D body model can be retrieved.

/scans/{scanId}/fitted-body

GET

Check the status of canonicalized 3D body model generation process.

/scans/{scanId}/measurements

GET, POST

Initiate the creation of anthropometric measurements and body composition estimates for a given canonicalized 3D body model.

/scans/{scanId}/measurements/download-url

POST

Create a short-lived URL from where measurements and body composition insights can be retrieved.

Last updated