Body shape prediction

Initiate generation of a Body Shape Prediction asset

This operation tells Prism to take a Fitted Body asset and produce a Body Shape Prediction asset that can then be downloaded.

NOTE: This request will return an error if a Fitted Body has not already been successfully created. This can be generated by requesting a Body Asset, a process that automatically creates a Fitted Body.

post

/body-shape-prediction

Authorizations

Body

scanIdstringrequired

The id of the scan from which to make a prediction

Example: 6380a5cf-cce5-41bc-b01b-4d42b5752d1f

predictionTypestring · enumrequired

The type of prediction to make

Example: WEIGHT_LOSS

Options: WEIGHT_LOSS

relativeWeightChangenumber

A percentage change of a user's weight to target for the prediction

Example: -5

relativeBodyFatChangenumber

A percentage change of a user's body fat percentage to target for the prediction

Example: -10

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/body-shape-prediction' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "scanId": "6380a5cf-cce5-41bc-b01b-4d42b5752d1f",
    "predictionType": "WEIGHT_LOSS",
    "relativeWeightChange": -5,
    "relativeBodyFatChange": -10
  }'

201

400

401

403

422

500

{
  "id": "f4c2ef4a-dc5f-4d13-a6a9-43dc03c003fd",
  "state": "ASSET_SUCCEEDED",
  "scanId": "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
}

Fetch the status of a Body Shape Prediction asset creation operation

get

/body-shape-prediction/{bodyShapePredictionId}