API Reference v1.0

register a new user

This operation registers a new user in hosted API. After a new user is registered, a scan for this user can be registered with /scans.

post

/users

Body

emailstring | nullable

The email address of the user

Example: foo@bar.com

tokenstringrequired

A unique token for the user provided by the partner

Example: unique-user-token

weightall ofrequired

The user's weight

Example: {"value":80,"unit":"kg"}

heightall ofrequired

The user's height

Example: {"value":1.8,"unit":"m"}

sexstring · enumrequired

The user's sex

Example: male

Options: male, female, neutral, undefined

regionstring · enumrequired

The user's region

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america

usaResidencestring

The user's state of residence

Example: California

birthDatestringrequired

The user's birth date

Example: 1990-01-01

researchConsentbooleanrequired

Whether the user has consented to their data being used for research

Example: true

termsOfServiceall ofrequired

The terms of service

Example: {"accepted":true,"version":"1"}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.hosted.prismlabs.tech/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "foo@bar.com",
    "token": "unique-user-token",
    "weight": {
      "value": 80,
      "unit": "kg"
    },
    "height": {
      "value": 1.8,
      "unit": "m"
    },
    "sex": "male",
    "region": "north_america",
    "usaResidence": "California",
    "birthDate": "1990-01-01",
    "researchConsent": true,
    "termsOfService": {
      "accepted": true,
      "version": "1"
    }
  }'

201

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "foo@bar.com",
  "researchConsent": true
}

delete a user

This operation deletes a specific user.

delete

/users/{token}

Path parameters

tokenstringrequired

A unique token for the user provided by the partner

Example: unique-user-token

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.hosted.prismlabs.tech/users/{token}'

200

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "foo@bar.com",
  "researchConsent": true
}

get meta data of a user

This operation provides the meta data for a specific user.

get

/users/{token}

Path parameters

tokenstringrequired

A unique token for the user provided by the partner

Example: unique-user-token

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/users/{token}'

200

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "foo@bar.com",
  "researchConsent": true
}

update meta data of a user

This operation updates the meta data for a specific user.

patch

/users/{token}

Path parameters

tokenstringrequired

A unique token for the user provided by the partner

Example: unique-user-token

Body

emailstring | nullable

The email address of the user

Example: foo@bar.com

tokenstring

A unique token for the user provided by the partner

Example: unique-user-token

weightall of

The user's weight

Example: {"value":80,"unit":"kg"}

heightall of

The user's height

Example: {"value":1.8,"unit":"m"}

sexstring · enum

The user's sex

Example: male

Options: male, female, neutral, undefined

regionstring · enum

The user's region

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america

usaResidencestring

The user's state of residence

Example: California

birthDatestring

The user's birth date

Example: 1990-01-01

researchConsentboolean

Whether the user has consented to their data being used for research

Example: true

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.hosted.prismlabs.tech/users/{token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "foo@bar.com",
    "token": "unique-user-token",
    "weight": {
      "value": 80,
      "unit": "kg"
    },
    "height": {
      "value": 1.8,
      "unit": "m"
    },
    "sex": "male",
    "region": "north_america",
    "usaResidence": "California",
    "birthDate": "1990-01-01",
    "researchConsent": true
  }'

200

{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "foo@bar.com",
  "researchConsent": true
}

get

/users/{userToken}/terms

Path parameters

userTokenstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/users/{userToken}/terms'

200

[
  {
    "userId": "text",
    "userToken": "text",
    "accepted": true,
    "version": "text",
    "acceptanceDate": "text"
  }
]

post

/users/{userToken}/terms

Path parameters

userTokenstringrequired

Body

versionstring

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.hosted.prismlabs.tech/users/{userToken}/terms' \
  --header 'Content-Type: application/json' \
  --data '{
    "version": "text"
  }'

201

{
  "userId": "text",
  "userToken": "text",
  "accepted": true,
  "version": "text",
  "acceptanceDate": "text"
}

register a new scan

This operation registers a new scan in hosted API.

post

/scans

Body

userTokenstringrequired

A unique token for the user provided by the partner, that should be associated with the scan

Example: unique-user-token

deviceConfigNamestring · enumrequired

The name of the device configuration used for the scan

Example: IPHONE_SCANNER

Options: IPHONE_SCANNER, ANDROID_SCANNER

assetConfigIdstring

The asset configuration used for the scan

bodyfatMethodstring · enum

The requested bodyfat method for the scan

Example: coco

Options: adam, army, army_athlete, coco, coco_bri, coco_legacy, extended_navy_thinboost, tina_fit

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.hosted.prismlabs.tech/scans' \
  --header 'Content-Type: application/json' \
  --data '{
    "userToken": "unique-user-token",
    "deviceConfigName": "IPHONE_SCANNER",
    "assetConfigId": "",
    "bodyfatMethod": "coco"
  }'

201

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

get status of a scan

This operation provides the status of a specific scan.

get

/scans/{id}

Path parameters

idstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{id}'

200

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

delete a scan

This operation deletes a specific scan.

delete

/scans/{id}

Path parameters

idstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.hosted.prismlabs.tech/scans/{id}'

200

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

get body measurements of a scan

This operation provides the body measurements of a specific scan.

get

/scans/{scanId}/measurements

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/measurements'

200

{
  "neckFit": 1,
  "shoulderFit": 1,
  "upperChestFit": 1,
  "chestFit": 1,
  "lowerChestFit": 1,
  "waistFit": 1,
  "waistNavyFit": 1,
  "stomachFit": 1,
  "hipsFit": 1,
  "upperThighLeftFit": 1,
  "upperThighRightFit": 1,
  "thighLeftFit": 1,
  "thighRightFit": 1,
  "lowerThighLeftFit": 1,
  "lowerThighRightFit": 1,
  "calfLeftFit": 1,
  "calfRightFit": 1,
  "ankleLeftFit": 1,
  "ankleRightFit": 1,
  "midArmRightFit": 1,
  "midArmLeftFit": 1,
  "lowerArmRightFit": 1,
  "lowerArmLeftFit": 1,
  "waistToHipRatio": 1,
  "forearmLeftFit": 1,
  "forearmRightFit": 1,
  "wristLeftFit": 1,
  "wristRightFit": 1
}

get the upload url

This operation provides an upload url for a specific scan for uploading capture data to Prism.

post

/scans/{scanId}/upload-url

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/upload-url'

201

{
  "expirationTime": "text",
  "url": "https://signed-url"
}

get asset status of a scan

This operation provides the asset status of a specific scan.

get

/scans/{scanId}/scan-assets

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/scan-assets'

200

{
  "id": "unique-scan-asset-id",
  "scanId": "unique-scan-id",
  "captureData": "succeeded",
  "captureDataUpdatedAt": "text",
  "body": "started",
  "bodyUpdatedAt": "text",
  "fittedBody": null,
  "fittedBodyUpdatedAt": "text",
  "measurement": null,
  "measurementUpdatedAt": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

get asset urls of a scan

This operation provides the asset urls of a specific scan.

get

/scans/{scanId}/asset-urls

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls'

200

{
  "previewImage": "text",
  "model": "text",
  "canonicalBody": "text",
  "texture": "text",
  "material": "text",
  "stripes": "text"
}

get specific asset url of a scan

This operation provides a specific asset url of a specific scan.

get

/scans/{scanId}/asset-urls/{assetType}

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

assetTypestring · enumrequired

The specific asset type of the scan

Options: preview-image, model, stripes

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls/{assetType}'

200

text

get bodyfat of a scan

This operation provides the bodyfat of a specific scan.

get

/scans/{scanId}/bodyfat

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/bodyfat'

200

{
  "bodyfatMethod": "coco",
  "bodyfatPercentage": 20,
  "leanMassPercentage": 80,
  "fatMass": 16,
  "leanMass": 64
}

get the health report of a scan

This operation provides the health report of a specific scan.

get

/scans/{scanId}/health-report

Path parameters

scanIdstringrequired

The unique ID of the scan

Example: unique-scan-id

Query parameters

unit-systemstring · enum

The unit system in which values will be returned

Options: metric, imperial

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/scans/{scanId}/health-report'

200

{
  "scan": {},
  "user": {},
  "bodyFatPercentageReport": {},
  "leanMassReport": {},
  "fatMassReport": {},
  "waistCircumferenceReport": {},
  "waistToHipRatioReport": {},
  "waistToHeightRatioReport": {},
  "metabolismReport": {}
}

register a new body shape prediction

This operation registers a new body shape prediction for a specific scan.

NOTE: Either a target weight or a target body fat percentage (but not both) must be specified

post

/body-shape-prediction

Body

scanIdstringrequired

The unique ID of the scan on which the prediction should be based on

Example: unique-scan-id

predictionTypestring · enumrequired

The prediction type that should be used for the prediction

Example: weight_loss

Options: weight_loss

targetWeightnumber · min: 1

The target weight (in kg) for the prediction. This or 'targetBodyfat' should be specified

Example: 50

targetBodyfatnumber · min: 1

The target body fat percentage for the prediction. This or 'targetWeight' should be specified

Example: 20

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.hosted.prismlabs.tech/body-shape-prediction' \
  --header 'Content-Type: application/json' \
  --data '{
    "scanId": "unique-scan-id",
    "predictionType": "weight_loss",
    "targetWeight": 50,
    "targetBodyfat": 20
  }'

201

{
  "id": "unique-body-shape-prediction-id",
  "status": "PROCESSING",
  "scanId": "unique-scan-id",
  "predictionType": "weight_loss",
  "targetWeight": 50,
  "targetBodyfat": 20,
  "createdAt": "text",
  "updatedAt": "text"
}

get status of a body shape prediction

This operation provides the status of a specific body shape prediction.

get

/body-shape-prediction/{bodyShapePredictionId}

Path parameters

bodyShapePredictionIdstringrequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}'

200

{
  "id": "unique-body-shape-prediction-id",
  "status": "PROCESSING",
  "scanId": "unique-scan-id",
  "predictionType": "weight_loss",
  "targetWeight": 50,
  "targetBodyfat": 20,
  "createdAt": "text",
  "updatedAt": "text"
}

get asset urls of a body shape prediction

This operation provides the asset urls of a specific body shape prediction.

get

/body-shape-prediction/{bodyShapePredictionId}/asset-urls

Path parameters

bodyShapePredictionIdstringrequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/asset-urls'

200

{
  "bodyShapePrediction": "text"
}

Users

Terms

Scans

Measurements

Upload URL

Scan Assets

Asset URLs

Bodyfat

Health Report

Future Me

Users

Terms

Scans

Measurements

Upload URL

Scan Assets

Asset URLs

Bodyfat

Health Report

Future Me

register a new user

delete a user

get meta data of a user

update meta data of a user

register a new scan

get status of a scan

delete a scan

get body measurements of a scan

get the upload url

get asset status of a scan

get asset urls of a scan

get specific asset url of a scan

get bodyfat of a scan

get the health report of a scan

register a new body shape prediction

get status of a body shape prediction

get asset urls of a body shape prediction

Users

Terms

Scans

Measurements

Upload URL

Scan Assets

Asset URLs

Bodyfat

Health Report

Future Me

Users

Terms

Scans

Measurements

Upload URL

Scan Assets

Asset URLs

Bodyfat

Health Report

Future Me

register a new user

Show child attributes

Show child attributes

Show child attributes

delete a user

get meta data of a user

update meta data of a user

Show child attributes

Show child attributes

register a new scan

get status of a scan

delete a scan

get body measurements of a scan

get the upload url

get asset status of a scan

get asset urls of a scan

get specific asset url of a scan

get bodyfat of a scan

get the health report of a scan

register a new body shape prediction

get status of a body shape prediction

get asset urls of a body shape prediction