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

Getting started with the Prism API

This section will help you get started with the Prism Labs Body Scanning and Insights API.

PreviousAPI Reference v1.0NextPartner & scanning devices onboarding

Last updated 1 year ago

The Prism API is an interface for interacting with Prism Labs’s computer vision and machine learning cloud pipeline for generating 3D body insights and assets. This pipeline takes in inputs (e.g. camera capture data from a scanner, or a reference to an asset already produced by the pipeline) and produces new assets as an output.

The API allows a partner to make specific inputs to the Prism pipeline, request status updates as the pipeline does its work, and request the resulting assets when it finishes. It works as a job system: request a job, wait for the job to finish, and download the finished assets.

The API was built with flexibility in mind so that requesting as many assets as desired can be done in a simple way. Because of this, certain jobs must be completed as prerequisites for other jobs (see section below).

Getting from scan to insights