API Reference
For Prism internal use only [Prism staging]
For Prism internal use only [Prism staging]
  • API Reference
  • Specifications
  • HOSTED API
    • API reference
      • Users
        • Terms
      • Scans
        • Measurements
        • Upload url
        • Scan assets
        • Asset urls
        • Bodyfat
        • Health report
      • Body shape prediction
        • Asset urls
    • Specification
  • PRISM API
    • About
    • API reference
      • Scans
        • Body
          • Download url
        • Fitted body
        • Measurements
          • Download url
        • Upload url
      • Users
      • Body shape prediction
        • Download url
    • Specification
Powered by GitBook
On this page
  1. PRISM API
  2. API reference
  3. Scans

Measurements

PreviousFitted bodyNextDownload url

Fetch the status of a Measurements asset creation operation

get
Authorizations
Path parameters
scanIdstringRequired
Responses
200Success
application/json;v=1
401
Unauthorized access. Please include a valid access token.
application/json;v=1
403
Forbidden access to resource. See documentation for more details.
application/json;v=1
404
An entity could not be found
application/json;v=1
500
An internal server error occurred
application/json;v=1
get
GET /scans/{scanId}/measurements HTTP/1.1
Host: api.prismlabs.tech
Authorization: Bearer JWT
Accept: */*

{
  "state": "ASSET_SUCCEEDED",
  "scanId": "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
}

Initiate generation of a Measurements asset

post

This operation tells Prism to take a Fitted Body asset and produce a Measurements 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.

Authorizations
Path parameters
scanIdstringRequired
Responses
201Success
application/json;v=1
400
A bad request was made
application/json;v=1
401
Unauthorized access. Please include a valid access token.
application/json;v=1
403
Forbidden access to resource. See documentation for more details.
application/json;v=1
422
A validation error occurred
application/json;v=1
500
An internal server error occurred
application/json;v=1
post
POST /scans/{scanId}/measurements HTTP/1.1
Host: api.prismlabs.tech
Authorization: Bearer JWT
Accept: */*

{
  "state": "ASSET_SUCCEEDED",
  "scanId": "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
}
  • GETFetch the status of a Measurements asset creation operation
  • POSTInitiate generation of a Measurements asset