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

bodyShapePredictionstring · nullableRequired

get

/body-shape-prediction/{bodyShapePredictionId}/asset-urls

HTTPcURLJavaScriptPython

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Body

application/json

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

/body-shape-prediction

HTTPcURLJavaScriptPython

POST /body-shape-prediction HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bodyShapePredictionIdstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned

Possible values:

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

statusstring · enumRequired

The body shape prediction status

Example: PROCESSINGPossible values:

scanIdstringRequired

The ID of the scan on which the prediction is based on

Example: unique-scan-id

predictionTypestring · enumRequired

The prediction type of the prediction

Example: weight_lossPossible values:

targetWeightnumber · nullableOptional

Target weight for the prediction

Example: 50

targetBodyfatnumber · nullableOptional

Target body fat for the prediction

Example: 20

createdAtstringRequired

The date and time the body shape prediction was created

updatedAtstringRequired

The date and time the body shape prediction was last updated

get

/body-shape-prediction/{bodyShapePredictionId}

HTTPcURLJavaScriptPython

GET /body-shape-prediction/{bodyShapePredictionId} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
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.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bodyShapePredictionIdstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

statusstring · enumRequired

The body shape prediction status

Example: PROCESSINGPossible values:

scanIdstringRequired

The ID of the scan on which the prediction is based on

Example: unique-scan-id

predictionTypestring · enumRequired

The prediction type of the prediction

Example: weight_lossPossible values:

targetWeightnumber · nullableOptional

Target weight for the prediction

Example: 50

targetBodyfatnumber · nullableOptional

Target body fat for the prediction

Example: 20

createdAtstringRequired

The date and time the body shape prediction was created

updatedAtstringRequired

The date and time the body shape prediction was last updated

delete

/body-shape-prediction/{bodyShapePredictionId}

HTTPcURLJavaScriptPython

DELETE /body-shape-prediction/{bodyShapePredictionId} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
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.

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

idstringRequired

The unique ID of the body shape prediction

Example: unique-body-shape-prediction-id

statusstring · enumRequired

The body shape prediction status

Example: PROCESSINGPossible values:

scanIdstringRequired

The ID of the scan on which the prediction is based on

Example: unique-scan-id

predictionTypestring · enumRequired

The prediction type of the prediction

Example: weight_lossPossible values:

targetWeightnumber · nullableOptional

Target weight for the prediction

Example: 50

targetBodyfatnumber · nullableOptional

Target body fat for the prediction

Example: 20

createdAtstringRequired

The date and time the body shape prediction was created

updatedAtstringRequired

The date and time the body shape prediction was last updated

get

/scans/{scanId}/body-shape-predictions

HTTPcURLJavaScriptPython

GET /scans/{scanId}/body-shape-predictions HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
]