API Reference 1.0
Last updated
Last updated
Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint
A URL for download a generated body
"https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."
An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.
"2022-06-13T23:02:48Z"
Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint
A URL for download a generated body
"https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."
An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.
"2022-06-13T23:02:48Z"
The scan id
"7f2ec6e0-b06d-42b1-b2a1-fff59a458490"
The id for the device config used to produce the scan
"36b516c7-e598-40a2-9b9a-2016364657ab"
The id for the asset config used to produce the scan
"6dbade37-bb49-449f-bb8b-7bc9226a028d"
The id for the user associated with this scan
"5304329f-bcb8-48f0-9661-5ac06b2515b1"
The current state of the scan. The following states are possible:
SCAN_WAITING_FOR_INPUT
: The scan is waiting for an input resource to be uploadedSCAN_VALIDATING_INPUT
: The scan is validating the uploaded inputSCAN_INPUT_VALID
: The scan input has been verified for useSCAN_INPUT_INVALID
: There was a problem processing the input within Prism API, such as a failed upload, invalid data, system errors, etc."SCAN_INPUT_VALID"
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the body asset
"c4009ab7-25c6-4756-aea1-f6047be984e7"
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the measurements
"6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
This operation registers a new scan in Prism. A scan id is returned, which will be used in subsequent requests.
After registering a scan, capture data must be uploaded.
IMPORTANT: The user of this scan should be updated with current information (e.g. weight) before calling this operation.
The id for the device config used to produce the scan
"36b516c7-e598-40a2-9b9a-2016364657ab"
The id for the asset config used to produce the scan
"6dbade37-bb49-449f-bb8b-7bc9226a028d"
The id for the user who is to be scanned
"7a50198f-d866-4772-9c2e-1b2ff8408128"
Various consent flags for the scan. If not provided, scan is opted out of all consent fields.
The scan id
"7f2ec6e0-b06d-42b1-b2a1-fff59a458490"
The id for the device config used to produce the scan
"36b516c7-e598-40a2-9b9a-2016364657ab"
The id for the asset config used to produce the scan
"6dbade37-bb49-449f-bb8b-7bc9226a028d"
The id for the user associated with this scan
"5304329f-bcb8-48f0-9661-5ac06b2515b1"
The current state of the scan. The following states are possible:
SCAN_WAITING_FOR_INPUT
: The scan is waiting for an input resource to be uploadedSCAN_VALIDATING_INPUT
: The scan is validating the uploaded inputSCAN_INPUT_VALID
: The scan input has been verified for useSCAN_INPUT_INVALID
: There was a problem processing the input within Prism API, such as a failed upload, invalid data, system errors, etc."SCAN_INPUT_VALID"
The generation of a fitted body asset is automatically initiated upon successful completion of a Body asset.
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the fitted body asset
"824af18d-2e8d-4665-ba6b-a955106f0d31"
The id of the body shape prediction
"f4c2ef4a-dc5f-4d13-a6a9-43dc03c003fd"
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the body shape prediction
"6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint
A URL for download a generated body
"https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."
An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.
"2022-06-13T23:02:48Z"
Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint
A URL for download a generated body
"https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."
An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.
"2022-06-13T23:02:48Z"
This operation tells Prism to take validated capture data and produce a body avatar asset that can then be downloaded.
IMPORTANT: The generation of a fitted body asset will be automatically initiated upon successful completion.
NOTE: Capture data must already be in a validated state, or this request will return an error.
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the body asset
"c4009ab7-25c6-4756-aea1-f6047be984e7"
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.
Describes the current state of the asset. The following states are possible:
ASSET_REQUESTED
: The asset is waiting to be processed by the pipelineASSET_REQUEST_FAILED
: The asset request to start processing in the pipeline failedASSET_PROCESSING
: The asset is being processed in the pipelineASSET_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"ASSET_SUCCEEDED"
The id of the scan associated with the measurements
"6380a5cf-cce5-41bc-b01b-4d42b5752d1f"
Upload URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint
Note: Capture data should be packaged in a zip file format.
The type of input resource to upload to the system (defaults to capture). The following types are possible:
capture
: The input resource is captured data from a scanbody
: The input resource is a body ply file"capture"
A URL for uploading a Scan's capture data.
"https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."
An expiration datetime for the Scan's Upload URL in ISO 8601 format in the UTC timezone.
"2022-06-13T23:02:48Z"
The user's registered id in Prism's system
"7f2ec6e0-b06d-42b1-b2a1-fff59a458490"
Describes the user's sex
"female"
Describes the region where the user is being registered
"north_america"
The user's birth year
1990
Describes the user's weight in kg or lb
Describes the user's height in m or in
Describes the user's sex
"female"
Describes the region where the user is being registered
"north_america"
The user's birth year
1990
Describes the user's weight in kilograms (kg) or pounds (lb)
Describes the user's height in meters (m) or inches (in)
The user's registered id in Prism's system
"7f2ec6e0-b06d-42b1-b2a1-fff59a458490"
Describes the user's sex
"female"
Describes the region where the user is being registered
"north_america"
The user's birth year
1990
Describes the user's weight in kg or lb
Describes the user's height in m or in
IMPORTANT: A user should be updated with current information (e.g. weight) before the creation a new scan.
Describes the user's sex
"female"
Describes the region where the user is being registered
"north_america"
The user's birth year
1990
Describes the user's weight in kilograms (kg) or pounds (lb)
Describes the user's height in meters (m) or inches (in)
The user's registered id in Prism's system
"7f2ec6e0-b06d-42b1-b2a1-fff59a458490"
Describes the user's sex
"female"
Describes the region where the user is being registered
"north_america"
The user's birth year
1990
Describes the user's weight in kg or lb
Describes the user's height in m or in