Scans Assets

Access assets generated from user body scans.

Use these endpoints to retrieve preview images, 3D body models and related visual assets generated for each scan. Typical use cases include powering scan galleries, 3D viewers and other visual experiences.

All Scans - Assets endpoints require the following headers:

accept: application/json;v=1
authorization: Bearer {{API_KEY}}
content-type: application/json

Replace {{API_KEY}} with your Prism API key for the selected environment.

Get asset status of a scan.

get

/scans/{scanId}/scan-assets

This operation provides the asset status for a specific scan, including which assets are generated and available.

Use this endpoint to check whether visual assets like models or preview images are ready.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Responses

200Success

application/json;v=1

idstringRequired

The unique ID of the scan assets

Example: unique-scan-asset-id

scanIdstringRequired

The ID of the scan associated with the assets

Example: unique-scan-id

captureDatastring · enum · nullableRequired

The status of the capture data associated with the scan

Example: succeededPossible values:

captureDataUpdatedAtstring · nullableRequired

The date and time the capture data was last updated

bodystring · enum · nullableRequired

The status of the body associated with the scan

Example: startedPossible values:

bodyUpdatedAtstring · nullableRequired

The date and time the body was last updated

fittedBodystring · enum · nullableOptional

The status of the fitted body associated with the scan

Possible values:

fittedBodyUpdatedAtstring · nullableRequired

The date and time the fitted body was last updated

measurementstring · enum · nullableOptional

The status of the measurement associated with the scan

Possible values:

measurementUpdatedAtstring · nullableRequired

The date and time the measurement was last updated

createdAtstringRequired

The date and time the scan assets were created

updatedAtstringRequired

The date and time the scan assets were last updated

get/scans/{scanId}/scan-assets

GET /scans/{scanId}/scan-assets HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "unique-scan-asset-id",
  "scanId": "unique-scan-id",
  "captureData": "succeeded",
  "captureDataUpdatedAt": "text",
  "body": "started",
  "bodyUpdatedAt": "text",
  "fittedBody": null,
  "fittedBodyUpdatedAt": "text",
  "measurement": null,
  "measurementUpdatedAt": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get asset URLs of a scan.

get

/scans/{scanId}/asset-urls

This operation provides the download URLs for all available assets of a specific scan.

The response includes URLs for assets such as preview images or 3D models.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Responses

200Success

application/json;v=1

previewImagestring · nullableRequired

modelstring · nullableRequired

canonicalBodystring · nullableRequired

texturestring · nullableRequired

materialstring · nullableRequired

stripesstring · nullableRequired

captureVideostring · nullableRequired

get/scans/{scanId}/asset-urls

GET /scans/{scanId}/asset-urls HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "previewImage": "text",
  "model": "text",
  "canonicalBody": "text",
  "texture": "text",
  "material": "text",
  "stripes": "text",
  "captureVideo": "text"
}

Get specific asset URL of a scan.

get

/scans/{scanId}/asset-urls/{assetType}

This operation provides the download URL for a specific asset type of a given scan.

Use this endpoint when you only need one asset, such as the preview image or 3D model, instead of requesting all asset URLs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

assetTypestring · enumRequired

The specific asset type of the scan

Possible values:

Responses

200Success

application/json;v=1

stringOptional

get/scans/{scanId}/asset-urls/{assetType}

GET /scans/{scanId}/asset-urls/{assetType} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

text