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.

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

Authorization

bearer

Body

application/json

scanId*string

The id of the scan from which to make a prediction

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

predictionType*enum

The type of prediction to make

Example: "WEIGHT_LOSS"

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

Response

201400401403422500

Body

application/json;v=1

id*string

The id of the body shape prediction

Example: "f4c2ef4a-dc5f-4d13-a6a9-43dc03c003fd"

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_FAILED: The asset processing failed due to an error, such as a failed upload, invalid data, system errors, etc.
• ASSET_SUCCEEDED: The asset processing succeeded and is ready for use

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the body shape prediction

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/body-shape-prediction', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "scanId": "6380a5cf-cce5-41bc-b01b-4d42b5752d1f",
      "predictionType": "WEIGHT_LOSS",
      "relativeWeightChange": -5,
      "relativeBodyFatChange": -10
    }),
});
const data = await response.json();

Response

201400401403422500

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

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

Authorization

bearer

Path parameters

bodyShapePredictionId*string

Response

200401403404500

Body

application/json;v=1

id*string

The id of the body shape prediction

Example: "f4c2ef4a-dc5f-4d13-a6a9-43dc03c003fd"

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_FAILED: The asset processing failed due to an error, such as a failed upload, invalid data, system errors, etc.
• ASSET_SUCCEEDED: The asset processing succeeded and is ready for use

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the body shape prediction

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

Request

JavaScriptCurlPythonHTTP

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

Response

200401403404500

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