Vectary

Vectary Model API

JavaScript API for programmatic control of Vectary 3D scenes embedded on websites. The VctrModelApi class (an ES module served from app.vectary.com) wraps postMessage communication with the embedded iframe, exposing async methods for configuration state, variants, materials and textures, two-way events, objects and transforms, camera and view state, animations, raycasting, screenshots, and file import/export. Available on Business plans; scenes are addressed by the Project ID from the embed URL.

GitHub

Documentation

📖
Documentation
https://help.vectary.com/api/model-api
📖
APIReference
https://help.vectary.com/api/model-api/api-reference
📖
GettingStarted
https://help.vectary.com/api/model-api/quick-start

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/vectary/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
aid: vectary:vectary-model-api
name: Vectary Model API
description: JavaScript API for programmatic control of Vectary 3D scenes embedded on websites. The VctrModelApi
  class (an ES module served from app.vectary.com) wraps postMessage communication with the embedded iframe,
  exposing async methods for configuration state, variants, materials and textures, two-way events, objects
  and transforms, camera and view state, animations, raycasting, screenshots, and file import/export.
  Available on Business plans; scenes are addressed by the Project ID from the embed URL.
humanURL: https://help.vectary.com/api/model-api
baseURL: https://app.vectary.com
tags:
- 3D
- Configurator
- JavaScript
- Embed
properties:
- type: Documentation
  url: https://help.vectary.com/api/model-api
- type: APIReference
  url: https://help.vectary.com/api/model-api/api-reference
- type: GettingStarted
  url: https://help.vectary.com/api/model-api/quick-start