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 endpoints

List of currently available endpoints and methods

All endpoints require the Accept header to specify the version using v=1 Accept: application/json;v=1

Endpoint
Method
Description

/users

GET, POST, PATCH

Register new users to be scanned. List/Update existing users.

/scans

GET, POST

Create a new scan entry, necessary for any new scan. Check scan status.

/scans/{scanId}/upload-url

POST

Create a short-lived URL to upload scan camera data.

/scans/{scanId}/body

GET, POST

Check status of the generation of the original 3D body model asset.

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

POST

Create a short-lived URL from where a 3D body model can be retrieved.

/scans/{scanId}/fitted-body

GET

Check the status of canonicalized 3D body model generation process.

/scans/{scanId}/measurements

GET, POST

Initiate the creation of anthropometric measurements and body composition estimates for a given canonicalized 3D body model.

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

POST

Create a short-lived URL from where measurements and body composition insights can be retrieved.

PreviousSample dataNextWebhook Notification Events

Last updated 1 year ago