Although we always try to keep our platform #no-code, sometimes you just can’t avoid it if you want to provide certain custom features, specially if you need to connect those features to an external site.

This documentation will allow you to crank up the dial of what is possible to achieve with your embedded models!

https://youtu.be/97w_JDQYOh0?si=WANy28ebpB90feiE

How does it work?

Vectary embeds are iframes which means they are isolated, and your website needs a messaging layer to communicate with them.

If your workspace is supplied with a Business plan, we provide a script that you can add to your site with all the messaging layer already implemented, so you don’t need to worry about it.

You will then be able to create instances of the Vectary API for the models you want to interact with on the site. From those instances you can gain access to the methods available to the models.

Take a look at the Quick Start section to get going!

What can I do with the Model API?

The Model API allows you to directly connect to Vectary embeds on your site using any of the methods in the table below. If you are familiar with other 3D model manipulation APIs like Three.js or Babylon.js, you will notice that there aren’t that many methods, and that’s because you can do most of things directly through Vectary’s Studio, without the need for coding.

API Reference

<aside> 📢 This is a work-in-progress API that will be updated and expanded with new features on a regular basis. If you have any specific questions or requests, please contact the Vectary customer success manager directly.

</aside>

Methods

Type Definitions

Here’s a collection of the different type definitions we use through the API.

API - Introduction

Model API Docs

Welcome developers!

How does it work?

What can I do with the Model API?

API Reference

Other sections

Quick Start

Events & Listeners

Floating UI Configurators

Ecommerce