Future Me

get asset urls of a body shape prediction

get

This operation provides the asset urls of a specific body shape prediction.

Path parameters
bodyShapePredictionIdstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id
Responses
200Success
application/json;v=1
get
GET /body-shape-prediction/{bodyShapePredictionId}/asset-urls HTTP/1.1
Host: api.hosted.prismlabs.tech
Accept: */*
200Success
{
  "bodyShapePrediction": "text"
}

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_lossPossible values:
targetWeightnumber · min: 1Optional

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

Example: 50
targetBodyfatnumber · min: 1Optional

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

Example: 20
Responses
201Success
application/json;v=1
post
POST /body-shape-prediction HTTP/1.1
Host: api.hosted.prismlabs.tech
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "scanId": "unique-scan-id",
  "predictionType": "weight_loss",
  "targetWeight": 50,
  "targetBodyfat": 20
}
201Success
{
  "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
200Success
application/json;v=1
get
GET /body-shape-prediction/{bodyShapePredictionId} HTTP/1.1
Host: api.hosted.prismlabs.tech
Accept: */*
200Success
{
  "id": "unique-body-shape-prediction-id",
  "status": "PROCESSING",
  "scanId": "unique-scan-id",
  "predictionType": "weight_loss",
  "targetWeight": 50,
  "targetBodyfat": 20,
  "createdAt": "text",
  "updatedAt": "text"
}

delete a body shape prediction

delete

This operation deletes a specific body shape prediction.

Path parameters
bodyShapePredictionIdstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id
Responses
200Success
application/json;v=1
delete
DELETE /body-shape-prediction/{bodyShapePredictionId} HTTP/1.1
Host: api.hosted.prismlabs.tech
Accept: */*
200Success
{
  "id": "unique-body-shape-prediction-id",
  "status": "PROCESSING",
  "scanId": "unique-scan-id",
  "predictionType": "weight_loss",
  "targetWeight": 50,
  "targetBodyfat": 20,
  "createdAt": "text",
  "updatedAt": "text"
}

get all body shape predictions for a scan

get

This operation returns all body shape predictions associated with a specific scan.

Path parameters
scanIdstringRequired

The unique ID of the scan

Example: unique-scan-id
Responses
200Success
application/json;v=1
get
GET /scans/{scanId}/body-shape-predictions HTTP/1.1
Host: api.hosted.prismlabs.tech
Accept: */*
200Success
[
  {
    "id": "unique-body-shape-prediction-id",
    "status": "PROCESSING",
    "scanId": "unique-scan-id",
    "predictionType": "weight_loss",
    "targetWeight": 50,
    "targetBodyfat": 20,
    "createdAt": "text",
    "updatedAt": "text"
  }
]
PreviousAssetsNextTerms