API Reference
API Reference [dev]
API Reference [dev]
  • Hosted API
    • API Reference v1.0
    • Specifications
  • PRISM API
    • Getting started with the Prism API
      • Partner & scanning devices onboarding
      • API Authentication
      • API Version
      • API responses and assets delivery
      • Getting from scan to insights
      • Sample data
      • API endpoints
      • Webhook Notification Events
      • Uploading data
    • API Reference 1.0
    • Specifications
Powered by GitBook
On this page
  1. PRISM API
  2. Getting started with the Prism API

API responses and assets delivery

PreviousAPI VersionNextGetting from scan to insights

Last updated 1 year ago

Given that the assets returned from the API are often bigger than the typical API responses in other platforms, our API relies on AWS S3 buckets to deliver all assets. A single high-resolution 3D mesh file can be in the single-digit MBs. For endpoints that return assets, a short-lived download URL will be provided from where the assets can be downloaded from.

All responses are in either JSON format for numerical/string data, or zip files containing .ply files for body avatar meshes, or a combination of both. Please note that Prism Labs does not currently guarantee storage of generated assets in the long term and it is expected that partners will download the requested assets and store them in their own systems.

Sample files of what the payload coming from the Prism API looks like can be found in the

Sample Data section.