Assets

get body measurements of a scan

get

This operation provides the body measurements of a specific scan.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{scanId}/measurements

HTTPcURLJavaScriptPython

GET /scans/{scanId}/measurements HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "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,
  "bmiPredicted": 1,
  "bmiConfidence": 1,
  "bodyRoundnessIndex": 1,
  "fullBodyVolume": 1
}

get asset status of a scan

get

This operation provides the asset status of a specific scan.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

Responses

200Success

application/json;v=1

get

/scans/{scanId}/scan-assets

HTTPcURLJavaScriptPython

GET /scans/{scanId}/scan-assets HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

get

This operation provides the asset urls of a specific scan.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

Responses

200Success

application/json;v=1

get

/scans/{scanId}/asset-urls

HTTPcURLJavaScriptPython

GET /scans/{scanId}/asset-urls HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

get specific asset url of a scan

get

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

assetTypestring · enumRequired

The specific asset type of the scan

Possible values:

Responses

200Success

application/json;v=1

Responsestring

get

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

HTTPcURLJavaScriptPython

GET /scans/{scanId}/asset-urls/{assetType} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

text

get bodyfat of a scan

get

This operation provides the bodyfat of a specific scan.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{scanId}/bodyfat

HTTPcURLJavaScriptPython

GET /scans/{scanId}/bodyfat HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "bodyfatMethod": "coco",
  "bodyfatPercentage": 20,
  "leanMassPercentage": 80,
  "fatMass": 16,
  "leanMass": 64,
  "vatPercentage": 1.5,
  "vatMass": 1.2,
  "appendicularLeanMassPercentage": 20,
  "appendicularLeanMass": 16,
  "skeletalMuscleMassPercentage": 20,
  "skeletalMuscleMass": 16
}

update bodyfat method of a scan

patch

This operation updates the bodyfat method of a scan.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Body

application/json

bodyfatMethodstring · enumRequired

A new bodyfat method to to use for the scan

Example: cocoPossible values:

Responses

200Success

application/json;v=1

patch

/scans/{scanId}/bodyfat

HTTPcURLJavaScriptPython

PATCH /scans/{scanId}/bodyfat HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "bodyfatMethod": "coco"
}

200Success

{
  "bodyfatMethod": "coco",
  "bodyfatPercentage": 20,
  "leanMassPercentage": 80,
  "fatMass": 16,
  "leanMass": 64,
  "vatPercentage": 1.5,
  "vatMass": 1.2,
  "appendicularLeanMassPercentage": 20,
  "appendicularLeanMass": 16,
  "skeletalMuscleMassPercentage": 20,
  "skeletalMuscleMass": 16
}