Overview

Welcome to BioDigital Human Viewer API! The BioDigital Human is a virtual body platform that powers interactive 3D visualizations for health, medicine and wellness applications. The Viewer API is your key to integrating the power of the BioDigital Human platform into your web sites and applications. It allows you to programmatically manipulate 3D models embedded in your applications and to map data to and from them.

In order to fully leverage the capabilities of the Viewer API, it is important to first understand how the various components of the platform work together.

1. 3D Models

The BioDigital Human Platform begins with our vast library of over 8,000 individually selectable anatomical structures and hundreds of simulated health conditions hand-crafted by our artists and vetted by medical professionals. These models are building blocks that you will integrate and customize to create an engaging experience for your users.

2. BioDigital Human

The BioDigital Human web app is the portal through which you can explore and customize our 3D content to meet the needs of your users. Using sophisticated search functionality to discover content and a suite of authoring tools to customize it to your needs and to map your data to it, you'll be able to craft the experiences that best suit your users. Check out our complete guide on content creation with the BioDigital Human.

Visit human.biodigital.com or our Android or iOS app to start browsing content for your website or application.

3. Human Viewer

Once you have selected and customized a 3D model, you can generate a Human Viewer to integrate into your web site or application. The Human Viewer is served by BioDigital enterprise cloud which has been architected for scalability, stability, performance and compatibility across devices and browsers.

Basic customization of the Viewer (background color, navigation tools, etc) is available via simple URL parameters. More advanced integrations can be developed using the Viewer API. Native mobile integration using our mobile SDKs (iOS and Android) are currently available in beta form to select partners – contact us for more information.

4. Viewer API

The Viewer API is a simple JavaScript messaging API that enables interactions between your website and an integrated Human Viewer. The API allows you to programmatically load 3D content, map data to and from it, manipulate the 3D scene based on user interactions on your page, or update your page based on user interactions with the 3D scene.

human.send("camera.set", {
  position: {
    x: 20,
    y: 40,
    z: 0
  },
  animate: true
});

We continue to add new functions to our API, so your feedback is extremely important to us.

Please send us your thoughts to developers@biodigital.com.