API Reference 1.0

Scans

Users

Body

Fitted Body

Measurements

Body Shape Prediction

Scans Upload URL

PreviousUploading data

Last updated 7 months ago

Register a scan

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.

post

/scans

Authorizations

Body

deviceConfigIdstringrequired

The id for the device config used to produce the scan

Example: 36b516c7-e598-40a2-9b9a-2016364657ab

assetConfigIdstring

The id for the asset config used to produce the scan

Example: 6dbade37-bb49-449f-bb8b-7bc9226a028d

userIdstringrequired

The id for the user who is to be scanned

Example: 7a50198f-d866-4772-9c2e-1b2ff8408128

consentall of

Various consent flags for the scan. If not provided, scan is opted out of all consent fields.

Example: {"fullResearch":true}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"deviceConfigId":"36b516c7-e598-40a2-9b9a-2016364657ab","assetConfigId":"6dbade37-bb49-449f-bb8b-7bc9226a028d","userId":"7a50198f-d866-4772-9c2e-1b2ff8408128","consent":{"fullResearch":true}}'

201

400

401

403

422

500

{
  "deviceConfigId": "36b516c7-e598-40a2-9b9a-2016364657ab",
  "assetConfigId": "6dbade37-bb49-449f-bb8b-7bc9226a028d",
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "userId": "5304329f-bcb8-48f0-9661-5ac06b2515b1",
  "state": "SCAN_INPUT_VALID"
}

Fetch the status of scan

get

/scans/{scanId}

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/scans/{scanId}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "deviceConfigId": "36b516c7-e598-40a2-9b9a-2016364657ab",
  "assetConfigId": "6dbade37-bb49-449f-bb8b-7bc9226a028d",
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "userId": "5304329f-bcb8-48f0-9661-5ac06b2515b1",
  "state": "SCAN_INPUT_VALID"
}

Register a new user

post

/users

Authorizations

Body

birthYearnumberrequired

The user's birth year

Example: 1990

sexenumrequired

Describes the user's sex

Example: female

Options: male, female, neutral, undefined

regionenumrequired

Describes the region where the user is being registered

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america, unspecified

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/users' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"birthYear":1990,"sex":"female","region":"north_america","weight":{"value":80,"unit":"kg"},"height":{"value":1.7,"unit":"m"}}'

201

400

401

403

422

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Fetch a user

get

/users/{userId}

Authorizations

Path parameters

userIdstringrequired

Query parameters

weight-unitenum

The unit in which the weight will be returned

Options: kg, lb

height-unitenum

The unit in which the height will be returned

Options: m, in

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/users/{userId}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Update a user

IMPORTANT: A user should be updated with current information (e.g. weight) before the creation a new scan.

patch

/users/{userId}

Authorizations

Path parameters

userIdstringrequired

Query parameters

weight-unitenum

The unit in which the weight will be returned

Options: kg, lb

height-unitenum

The unit in which the height will be returned

Options: m, in

Body

birthYearnumber

The user's birth year

Example: 1990

sexenum

Describes the user's sex

Example: female

Options: male, female, neutral, undefined

regionenum

Describes the region where the user is being registered

Example: north_america

Options: africa, asia, caribbean, central_america, europe, north_america, oceania, south_america, unspecified

weightall of

Describes the user's weight in kilograms (kg) or pounds (lb)

Example: {"value":80,"unit":"kg"}

heightall of

Describes the user's height in meters (m) or inches (in)

Example: {"value":1.7,"unit":"m"}

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.prismlabs.tech/users/{userId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"birthYear":1990,"sex":"female","region":"north_america","weight":{"value":80,"unit":"kg"},"height":{"value":1.7,"unit":"m"}}'

200

400

401

403

422

500

{
  "birthYear": 1990,
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.7,
    "unit": "m"
  }
}

Initiate generation of a Body asset

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.

post

/scans/{scanId}/body

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans/{scanId}/body' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

{
  "scanId": "c4009ab7-25c6-4756-aea1-f6047be984e7",
  "state": "ASSET_SUCCEEDED"
}

Fetch the status of a Body asset creation operation

get

/scans/{scanId}/body

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/scans/{scanId}/body' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "scanId": "c4009ab7-25c6-4756-aea1-f6047be984e7",
  "state": "ASSET_SUCCEEDED"
}

Create a download URL for a Body asset

Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint

post

/scans/{scanId}/body/download-url

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans/{scanId}/body/download-url' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

{
  "url": "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?...",
  "expirationTime": "2022-06-13T23:02:48Z"
}

Fetch the status of a Fitted Body asset creation operation

The generation of a fitted body asset is automatically initiated upon successful completion of a Body asset.

get

/scans/{scanId}/fitted-body

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/scans/{scanId}/fitted-body' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "scanId": "824af18d-2e8d-4665-ba6b-a955106f0d31",
  "state": "ASSET_SUCCEEDED"
}

Fetch the status of a Measurements asset creation operation

get

/scans/{scanId}/measurements

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/scans/{scanId}/measurements' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

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

Initiate generation of a Measurements asset

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.

post

/scans/{scanId}/measurements

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans/{scanId}/measurements' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

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

Create a download URL for a Measurement asset

Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint

post

/scans/{scanId}/measurements/download-url

Authorizations

Path parameters

scanIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans/{scanId}/measurements/download-url' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

{
  "url": "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?...",
  "expirationTime": "2022-06-13T23:02:48Z"
}

Fetch the status of a Body Shape Prediction asset creation operation

get

/body-shape-prediction/{bodyShapePredictionId}

Authorizations

Path parameters

bodyShapePredictionIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

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

Create a download URL for a Body Shape Prediction asset

Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint

post

/body-shape-prediction/{bodyShapePredictionId}/download-url

Authorizations

Path parameters

bodyShapePredictionIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

{
  "url": "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?...",
  "expirationTime": "2022-06-13T23:02:48Z"
}

Create a download URL for a Body Shape Prediction asset

Download URLs will be valid for one hour. New URLs may be generated with further requests to this endpoint

post

/body-shape-prediction/{bodyShapePredictionId}/download-url

Authorizations

Path parameters

bodyShapePredictionIdstringrequired

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url' \
  --header 'Authorization: Bearer JWT'

201

400

401

403

422

500

{
  "url": "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?...",
  "expirationTime": "2022-06-13T23:02:48Z"
}

Create a URL for uploading an input resource for a scan

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.

post

/scans/{scanId}/upload-url

Authorizations

Path parameters

scanIdstringrequired

Body

inputResourceenum

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 scan
body: The input resource is a body ply file

Example: capture

Options: capture, body, none

Responses

application/json;v=1

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.prismlabs.tech/scans/{scanId}/upload-url' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"inputResource":"capture"}'

201

400

401

403

422

500

{
  "url": "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?...",
  "expirationTime": "2022-06-13T23:02:48Z"
}