API Reference 1.0

Scans

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.

POSThttps://api.prismlabs.tech/scans

Authorization

bearer

Body

application/json

deviceConfigId*string

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"

userId*string

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}

Response

201400401403422500

Body

application/json;v=1

id*string

The scan id

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

deviceConfigId*string

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"

userId*string

The id for the user associated with this scan

Example: "5304329f-bcb8-48f0-9661-5ac06b2515b1"

state*enum

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 uploaded
• SCAN_VALIDATING_INPUT: The scan is validating the uploaded input
• SCAN_INPUT_VALID: The scan input has been verified for use
• SCAN_INPUT_INVALID: There was a problem processing the input within Prism API, such as a failed upload, invalid data, system errors, etc.

Example: "SCAN_INPUT_VALID"

SCAN_WAITING_FOR_INPUTSCAN_VALIDATING_INPUTSCAN_INPUT_VALIDSCAN_INPUT_INVALID

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceConfigId": "36b516c7-e598-40a2-9b9a-2016364657ab",
      "assetConfigId": "6dbade37-bb49-449f-bb8b-7bc9226a028d",
      "userId": "7a50198f-d866-4772-9c2e-1b2ff8408128",
      "consent": {
        "fullResearch": true
      }
    }),
});
const data = await response.json();

Response

201400401403422500

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

Fetch the status of scan

GEThttps://api.prismlabs.tech/scans/{scanId}

Authorization

bearer

Path parameters

scanId*string

Response

200401403404500

Body

application/json;v=1

id*string

The scan id

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

deviceConfigId*string

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"

userId*string

The id for the user associated with this scan

Example: "5304329f-bcb8-48f0-9661-5ac06b2515b1"

state*enum

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 uploaded
• SCAN_VALIDATING_INPUT: The scan is validating the uploaded input
• SCAN_INPUT_VALID: The scan input has been verified for use
• SCAN_INPUT_INVALID: There was a problem processing the input within Prism API, such as a failed upload, invalid data, system errors, etc.

Example: "SCAN_INPUT_VALID"

SCAN_WAITING_FOR_INPUTSCAN_VALIDATING_INPUTSCAN_INPUT_VALIDSCAN_INPUT_INVALID

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

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

Users

Register a new user

POSThttps://api.prismlabs.tech/users

Authorization

bearer

Body

application/json

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

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"}

Response

201400401403422500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

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

heightall of

Describes the user's height in m or in

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sex": "female",
      "region": "north_america",
      "birthYear": 1990,
      "weight": {
        "value": 80,
        "unit": "kg"
      },
      "height": {
        "value": 1.7,
        "unit": "m"
      }
    }),
});
const data = await response.json();

Response

201400401403422500

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

Fetch a user

GEThttps://api.prismlabs.tech/users/{userId}

Authorization

bearer

Path parameters

userId*string

Query parameters

Response

200401403404500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

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

heightall of

Describes the user's height in m or in

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users/{userId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

{
  "id": "7f2ec6e0-b06d-42b1-b2a1-fff59a458490",
  "sex": "female",
  "region": "north_america",
  "birthYear": 1990,
  "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.

PATCHhttps://api.prismlabs.tech/users/{userId}

Authorization

bearer

Path parameters

userId*string

Query parameters

Body

application/json

sexenum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

regionenum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYearnumber

The user's birth year

Example: 1990

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"}

Response

200400401403422500

Body

application/json;v=1

id*string

The user's registered id in Prism's system

Example: "7f2ec6e0-b06d-42b1-b2a1-fff59a458490"

sex*enum

Describes the user's sex

Example: "female"

malefemaleneutralundefined

region*enum

Describes the region where the user is being registered

Example: "north_america"

africaasiacaribbeancentral_americaeuropenorth_americaoceaniasouth_americaunspecified

birthYear*number

The user's birth year

Example: 1990

weightall of

Describes the user's weight in kg or lb

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

heightall of

Describes the user's height in m or in

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/users/{userId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sex": "female",
      "region": "north_america",
      "birthYear": 1990,
      "weight": {
        "value": 80,
        "unit": "kg"
      },
      "height": {
        "value": 1.7,
        "unit": "m"
      }
    }),
});
const data = await response.json();

Response

200400401403422500

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

Body

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.

POSThttps://api.prismlabs.tech/scans/{scanId}/body

Authorization

bearer

Path parameters

scanId*string

Response

201400401403422500

Body

application/json;v=1

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the body asset

Example: "c4009ab7-25c6-4756-aea1-f6047be984e7"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/body', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

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

Fetch the status of a Body asset creation operation

GEThttps://api.prismlabs.tech/scans/{scanId}/body

Authorization

bearer

Path parameters

scanId*string

Response

200401403404500

Body

application/json;v=1

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the body asset

Example: "c4009ab7-25c6-4756-aea1-f6047be984e7"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/body', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

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

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

POSThttps://api.prismlabs.tech/scans/{scanId}/body/download-url

Authorization

bearer

Path parameters

scanId*string

Response

201400401403422500

Body

application/json;v=1

url*string

A URL for download a generated body

Example: "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."

expirationTime*string

An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.

Example: "2022-06-13T23:02:48Z"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/body/download-url', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

{
  "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"
}

Fitted Body

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.

GEThttps://api.prismlabs.tech/scans/{scanId}/fitted-body

Authorization

bearer

Path parameters

scanId*string

Response

200401403404500

Body

application/json;v=1

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the fitted body asset

Example: "824af18d-2e8d-4665-ba6b-a955106f0d31"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/fitted-body', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

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

Measurements

Fetch the status of a Measurements asset creation operation

GEThttps://api.prismlabs.tech/scans/{scanId}/measurements

Authorization

bearer

Path parameters

scanId*string

Response

200401403404500

Body

application/json;v=1

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the measurements

Example: "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/measurements', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

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

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.

POSThttps://api.prismlabs.tech/scans/{scanId}/measurements

Authorization

bearer

Path parameters

scanId*string

Response

201400401403422500

Body

application/json;v=1

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the measurements

Example: "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/measurements', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

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

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

POSThttps://api.prismlabs.tech/scans/{scanId}/measurements/download-url

Authorization

bearer

Path parameters

scanId*string

Response

201400401403422500

Body

application/json;v=1

url*string

A URL for download a generated body

Example: "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."

expirationTime*string

An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.

Example: "2022-06-13T23:02:48Z"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/measurements/download-url', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

{
  "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"
}

Body Shape Prediction

Fetch the status of a Body Shape Prediction asset creation operation

GEThttps://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}

Authorization

bearer

Path parameters

bodyShapePredictionId*string

Response

200401403404500

Body

application/json;v=1

id*string

The id of the body shape prediction

Example: "f4c2ef4a-dc5f-4d13-a6a9-43dc03c003fd"

state*enum

Describes the current state of the asset. The following states are possible:

• ASSET_REQUESTED: The asset is waiting to be processed by the pipeline
• ASSET_REQUEST_FAILED: The asset request to start processing in the pipeline failed
• ASSET_PROCESSING: The asset is being processed in the pipeline
• ASSET_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

Example: "ASSET_SUCCEEDED"

ASSET_REQUESTEDASSET_REQUEST_FAILEDASSET_PROCESSINGASSET_FAILEDASSET_SUCCEEDED

scanId*string

The id of the scan associated with the body shape prediction

Example: "6380a5cf-cce5-41bc-b01b-4d42b5752d1f"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404500

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

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

POSThttps://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url

Authorization

bearer

Path parameters

bodyShapePredictionId*string

Response

201400401403422500

Body

application/json;v=1

url*string

A URL for download a generated body

Example: "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."

expirationTime*string

An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.

Example: "2022-06-13T23:02:48Z"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

{
  "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

POSThttps://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url

Authorization

bearer

Path parameters

bodyShapePredictionId*string

Response

201400401403422500

Body

application/json;v=1

url*string

A URL for download a generated body

Example: "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."

expirationTime*string

An expiration datetime for the Body's download URL in ISO 8601 format in the UTC timezone.

Example: "2022-06-13T23:02:48Z"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/body-shape-prediction/{bodyShapePredictionId}/download-url', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201400401403422500

{
  "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"
}

Scans Upload URL

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.

POSThttps://api.prismlabs.tech/scans/{scanId}/upload-url

Authorization

bearer

Path parameters

scanId*string

Body

application/json

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"

capturebodynone

Response

201400401403422500

Body

application/json;v=1

url*string

A URL for uploading a Scan's capture data.

Example: "https://prism-api-data-prod.s3.us-east-2.amazonaws.com/upload/a/b/capture-data/c.zip?..."

expirationTime*string

An expiration datetime for the Scan's Upload URL in ISO 8601 format in the UTC timezone.

Example: "2022-06-13T23:02:48Z"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.prismlabs.tech/scans/{scanId}/upload-url', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inputResource": "capture"
    }),
});
const data = await response.json();

Response

201400401403422500

{
  "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"
}