API Reference v1.0

Request Headers

Name	Value
Content-Type	application/json
Accept	application/json;v=1
Authorization	Bearer <token>

Users

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.

POSThttps://api.hosted.prismlabs.tech/users

Body

application/json

emailnullable string

The email address of the user

Example: "[e-mail]"

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

weight*all of

The user's weight

height*all of

The user's height

sex*enum

The user's sex

Example: "male"

malefemaleneutralundefined

region*enum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_america

usaResidencestring

The user's state of residence

Example: "California"

birthDate*string

The user's birth date

Example: "1990-01-01"

researchConsent*boolean

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

Example: true

termsOfService*all of

The terms of service

Response

201

Body

application/json;v=1

id*string

The unique ID of the user

Example: "unique-user-id"

sex*enum

The user's sex

Example: "male"

malefemaleneutralundefined

region*enum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_america

usaResidencenullable string

The user's state of residence

Example: "California"

birthDate*string

The user's birth date

Example: "1990-01-01"

weight*all of

The user's weight

height*all of

The user's height

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

emailnullable string

The email address of the user

Example: "[e-mail]"

researchConsent*boolean

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

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "unique-user-token",
      "weight": {
        "value": 80,
        "unit": "kg"
      },
      "height": {
        "value": 1.8,
        "unit": "m"
      },
      "sex": "male",
      "region": "north_america",
      "birthDate": "1990-01-01",
      "researchConsent": true,
      "termsOfService": {
        "accepted": true,
        "version": "1"
      }
    }),
});
const data = await response.json();

Response

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": "[e-mail]",
  "researchConsent": true
}

delete a user

This operation deletes a specific user.

DELETEhttps://api.hosted.prismlabs.tech/users/{token}

Path parameters

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

Response

200

Body

application/json;v=1

id*string

The unique ID of the user

Example: "unique-user-id"

sex*enum

The user's sex

Example: "male"

malefemaleneutralundefined

region*enum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_america

usaResidencenullable string

The user's state of residence

Example: "California"

birthDate*string

The user's birth date

Example: "1990-01-01"

weight*all of

The user's weight

height*all of

The user's height

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

emailnullable string

The email address of the user

Example: "[e-mail]"

researchConsent*boolean

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

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users/{token}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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": "[e-mail]",
  "researchConsent": true
}

get meta data of a user

This operation provides the meta data for a specific user.

GEThttps://api.hosted.prismlabs.tech/users/{token}

Path parameters

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

Response

200

Body

application/json;v=1

id*string

The unique ID of the user

Example: "unique-user-id"

sex*enum

The user's sex

Example: "male"

malefemaleneutralundefined

region*enum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_america

usaResidencenullable string

The user's state of residence

Example: "California"

birthDate*string

The user's birth date

Example: "1990-01-01"

weight*all of

The user's weight

height*all of

The user's height

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

emailnullable string

The email address of the user

Example: "[e-mail]"

researchConsent*boolean

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

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users/{token}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": "[e-mail]",
  "researchConsent": true
}

update meta data of a user

This operation updates the meta data for a specific user.

PATCHhttps://api.hosted.prismlabs.tech/users/{token}

Path parameters

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

Body

application/json

emailnullable string

The email address of the user

Example: "[e-mail]"

tokenstring

A unique token for the user provided by the partner

Example: "unique-user-token"

weightall of

The user's weight

heightall of

The user's height

sexenum

The user's sex

Example: "male"

malefemaleneutralundefined

regionenum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_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

Response

200

Body

application/json;v=1

id*string

The unique ID of the user

Example: "unique-user-id"

sex*enum

The user's sex

Example: "male"

malefemaleneutralundefined

region*enum

The user's region

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_america

usaResidencenullable string

The user's state of residence

Example: "California"

birthDate*string

The user's birth date

Example: "1990-01-01"

weight*all of

The user's weight

height*all of

The user's height

token*string

A unique token for the user provided by the partner

Example: "unique-user-token"

emailnullable string

The email address of the user

Example: "[e-mail]"

researchConsent*boolean

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

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users/{token}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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": "[e-mail]",
  "researchConsent": true
}

Terms

GEThttps://api.hosted.prismlabs.tech/users/{userToken}/terms

Path parameters

userToken*string

Response

200

Body

application/json;v=1

userId*string

userToken*string

accepted*boolean

version*nullable string

acceptanceDate*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users/{userToken}/terms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

POSThttps://api.hosted.prismlabs.tech/users/{userToken}/terms

Path parameters

userToken*string

Body

application/json

versionstring

Response

201

Body

application/json;v=1

userId*string

userToken*string

accepted*boolean

version*nullable string

acceptanceDate*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/users/{userToken}/terms', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

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

Scans

GEThttps://api.hosted.prismlabs.tech/scans

Response

200

Body

application/json;v=1

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

register a new scan

This operation registers a new scan in hosted API.

POSThttps://api.hosted.prismlabs.tech/scans

Body

application/json

userToken*string

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

Example: "unique-user-token"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigIdstring

The asset configuration used for the scan

Example: ""

bodyfatMethodenum

The requested bodyfat method for the scan

Example: "coco"

adamarmyarmy_athletecocococo_bricoco_legacyextended_navy_thinboosttina_fit

Response

201

Body

application/json;v=1

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

height*all of

The user's height

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userToken": "unique-user-token",
      "deviceConfigName": "IPHONE_SCANNER"
    }),
});
const data = await response.json();

Response

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": 0,
    "shoulderFit": 0,
    "upperChestFit": 0,
    "chestFit": 0,
    "lowerChestFit": 0,
    "waistFit": 0,
    "waistNavyFit": 0,
    "stomachFit": 0,
    "hipsFit": 0,
    "upperThighLeftFit": 0,
    "upperThighRightFit": 0,
    "thighLeftFit": 0,
    "thighRightFit": 0,
    "lowerThighLeftFit": 0,
    "lowerThighRightFit": 0,
    "calfLeftFit": 0,
    "calfRightFit": 0,
    "ankleLeftFit": 0,
    "ankleRightFit": 0,
    "midArmRightFit": 0,
    "midArmLeftFit": 0,
    "lowerArmRightFit": 0,
    "lowerArmLeftFit": 0,
    "waistToHipRatio": 0
  },
  "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.

GEThttps://api.hosted.prismlabs.tech/scans/{id}

Path parameters

id*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

height*all of

The user's height

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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": 0,
    "shoulderFit": 0,
    "upperChestFit": 0,
    "chestFit": 0,
    "lowerChestFit": 0,
    "waistFit": 0,
    "waistNavyFit": 0,
    "stomachFit": 0,
    "hipsFit": 0,
    "upperThighLeftFit": 0,
    "upperThighRightFit": 0,
    "thighLeftFit": 0,
    "thighRightFit": 0,
    "lowerThighLeftFit": 0,
    "lowerThighRightFit": 0,
    "calfLeftFit": 0,
    "calfRightFit": 0,
    "ankleLeftFit": 0,
    "ankleRightFit": 0,
    "midArmRightFit": 0,
    "midArmLeftFit": 0,
    "lowerArmRightFit": 0,
    "lowerArmLeftFit": 0,
    "waistToHipRatio": 0
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

delete a scan

This operation deletes a specific scan.

DELETEhttps://api.hosted.prismlabs.tech/scans/{id}

Path parameters

id*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

id*string

The unique ID of the scan

Example: "unique-scan-id"

status*enum

The scan status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

prismScanId*string

The ID of the scan in Prism

Example: "prism-unique-scan-id"

deviceConfigName*enum

The name of the device configuration used for the scan

Example: "IPHONE_SCANNER"

IPHONE_SCANNERANDROID_SCANNER

assetConfigId*string

The asset configuration used for the scan

Example: ""

weight*all of

The user's weight

height*all of

The user's height

userId*string

The user ID associated with the scan

Example: "unique-user-id"

userToken*string

The unique user token associated with the scan

Example: "unique-user-token"

createdAt*string

The date and time the scan was created

updatedAt*string

The date and time the scan was last updated

scanAssetsall of

The asset metadata associated with the scan

measurements*nullable all of

bodyfat*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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": 0,
    "shoulderFit": 0,
    "upperChestFit": 0,
    "chestFit": 0,
    "lowerChestFit": 0,
    "waistFit": 0,
    "waistNavyFit": 0,
    "stomachFit": 0,
    "hipsFit": 0,
    "upperThighLeftFit": 0,
    "upperThighRightFit": 0,
    "thighLeftFit": 0,
    "thighRightFit": 0,
    "lowerThighLeftFit": 0,
    "lowerThighRightFit": 0,
    "calfLeftFit": 0,
    "calfRightFit": 0,
    "ankleLeftFit": 0,
    "ankleRightFit": 0,
    "midArmRightFit": 0,
    "midArmLeftFit": 0,
    "lowerArmRightFit": 0,
    "lowerArmLeftFit": 0,
    "waistToHipRatio": 0
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64
  }
}

Measurements

get body measurements of a scan

This operation provides the body measurements of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/measurements

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

neckFit*number

shoulderFit*number

upperChestFit*number

chestFit*number

lowerChestFit*number

waistFit*number

waistNavyFit*number

stomachFit*number

hipsFit*number

upperThighLeftFit*number

upperThighRightFit*number

thighLeftFit*number

thighRightFit*number

lowerThighLeftFit*number

lowerThighRightFit*number

calfLeftFit*number

calfRightFit*number

ankleLeftFit*number

ankleRightFit*number

midArmRightFit*number

midArmLeftFit*number

lowerArmRightFit*number

lowerArmLeftFit*number

waistToHipRatio*number

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/measurements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Upload URL

get the upload url

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

POSThttps://api.hosted.prismlabs.tech/scans/{scanId}/upload-url

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Response

201

Body

application/json;v=1

expirationTime*string

Expiration time of the signed url

url*string

A signed url to upload capture data to prism

Example: "https://signed-url"

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/upload-url', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

201

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

Scan Assets

get asset status of a scan

This operation provides the asset status of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/scan-assets

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

id*string

The unique ID of the scan assets

Example: "unique-scan-asset-id"

scanId*string

The ID of the scan associated with the assets

Example: "unique-scan-id"

captureData*nullable enum

The status of the capture data associated with the scan

Example: "succeeded"

startedsucceededfailed

captureDataUpdatedAt*nullable string

The date and time the capture data was last updated

body*nullable enum

The status of the body associated with the scan

Example: "started"

startedsucceededfailed

bodyUpdatedAt*nullable string

The date and time the body was last updated

fittedBodynullable enum

The status of the fitted body associated with the scan

startedsucceededfailed

fittedBodyUpdatedAt*nullable string

The date and time the fitted body was last updated

measurementnullable enum

The status of the measurement associated with the scan

startedsucceededfailed

measurementUpdatedAt*nullable string

The date and time the measurement was last updated

createdAt*string

The date and time the scan assets were created

updatedAt*string

The date and time the scan assets were last updated

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/scan-assets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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"
}

Asset URLs

get asset urls of a scan

This operation provides the asset urls of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

previewImage*nullable string

model*nullable string

canonicalBody*nullable string

texture*nullable string

material*nullable string

stripes*nullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls/{assetType}

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

assetType*enum

The specific asset type of the scan

preview-imagemodelstripes

Response

200

Body

application/json;v=1

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/asset-urls/{assetType}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Bodyfat

get bodyfat of a scan

This operation provides the bodyfat of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/bodyfat

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Response

200

Body

application/json;v=1

bodyfatMethod*enum

Bodyfat method for the scan

Example: "coco"

adamarmyarmy_athletecocococo_bricoco_legacyextended_navy_thinboosttina_fit

bodyfatPercentage*nullable number

Bodyfat percentage

Example: 20

leanMassPercentage*nullable number

Lean mass percentage

Example: 80

fatMass*nullable number

fat mass in kg

Example: 16

leanMass*nullable number

lean mass in kg

Example: 64

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/bodyfat', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Health Report

get the health report of a scan

This operation provides the health report of a specific scan.

GEThttps://api.hosted.prismlabs.tech/scans/{scanId}/health-report

Path parameters

scanId*string

The unique ID of the scan

Example: "unique-scan-id"

Query parameters

Response

200

Body

application/json;v=1

scan*object

user*object

bodyFatPercentageReport*object

leanMassReport*object

fatMassReport*object

waistCircumferenceReport*object

waistToHipRatioReport*object

waistToHeightRatioReport*object

metabolismReport*object

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/scans/{scanId}/health-report', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Future Me

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

POSThttps://api.hosted.prismlabs.tech/body-shape-prediction

Body

application/json

scanId*string

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

Example: "unique-scan-id"

predictionType*enum

The prediction type that should be used for the prediction

Example: "weight_loss"

weight_loss

targetWeightnumber

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

Example: 50

targetBodyfatnumber

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

Example: 20

Response

201

Body

application/json;v=1

id*string

The unique ID of the body shape prediction

Example: "unique-body-shape-prediction-id"

status*enum

The body shape prediction status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

scanId*string

The ID of the scan on which the prediction is based on

Example: "unique-scan-id"

predictionType*enum

The prediction type of the prediction

Example: "weight_loss"

weight_loss

targetWeightnullable number

Target weight for the prediction

Example: 50

targetBodyfatnullable number

Target body fat for the prediction

Example: 20

createdAt*string

The date and time the body shape prediction was created

updatedAt*string

The date and time the body shape prediction was last updated

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/body-shape-prediction', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scanId": "unique-scan-id",
      "predictionType": "weight_loss"
    }),
});
const data = await response.json();

Response

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.

GEThttps://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}

Path parameters

bodyShapePredictionId*string

The unique ID of the body shape prediction

Example: "unique-body-shape-prediction-id"

Response

200

Body

application/json;v=1

id*string

The unique ID of the body shape prediction

Example: "unique-body-shape-prediction-id"

status*enum

The body shape prediction status

Example: "PROCESSING"

CREATEDPROCESSINGREADYFAILED

scanId*string

The ID of the scan on which the prediction is based on

Example: "unique-scan-id"

predictionType*enum

The prediction type of the prediction

Example: "weight_loss"

weight_loss

targetWeightnullable number

Target weight for the prediction

Example: 50

targetBodyfatnullable number

Target body fat for the prediction

Example: 20

createdAt*string

The date and time the body shape prediction was created

updatedAt*string

The date and time the body shape prediction was last updated

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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.

GEThttps://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/asset-urls

Path parameters

bodyShapePredictionId*string

The unique ID of the body shape prediction

Example: "unique-body-shape-prediction-id"

Response

200

Body

application/json;v=1

bodyShapePrediction*nullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.hosted.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/asset-urls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "bodyShapePrediction": "text"
}