Body shape prediction

register a new body shape prediction

post

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

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

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

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

get

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

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

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

200

200

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