> For the complete documentation index, see [llms.txt](https://help.vectary.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.vectary.com/api.md).

# API

- [Model API](https://help.vectary.com/api/model-api.md): Programmatic control of embedded Vectary 3D scenes via JavaScript
- [Quick Start](https://help.vectary.com/api/model-api/quick-start.md): Get the Model API running with your embedded Vectary project in 5 minutes.
- [Core Concepts](https://help.vectary.com/api/model-api/core-concepts.md): Essential concepts for working with the Model API. Understanding these will help you build effective integrations.
- [API Reference](https://help.vectary.com/api/model-api/api-reference.md): Complete list of Model API methods organized by category.
- [init](https://help.vectary.com/api/model-api/api-reference/init.md)
- [isReady](https://help.vectary.com/api/model-api/api-reference/isready.md)
- [projectInfo](https://help.vectary.com/api/model-api/api-reference/projectinfo.md)
- [dispatchEvent](https://help.vectary.com/api/model-api/api-reference/dispatchevent.md)
- [addEventListener](https://help.vectary.com/api/model-api/api-reference/addeventlistener.md)
- [removeEventListener](https://help.vectary.com/api/model-api/api-reference/removeeventlistener.md)
- [setConfigurationState](https://help.vectary.com/api/model-api/api-reference/setconfigurationstate.md)
- [getConfigurationState](https://help.vectary.com/api/model-api/api-reference/getconfigurationstate.md)
- [getObjects](https://help.vectary.com/api/model-api/api-reference/getobjects.md)
- [removeObjects](https://help.vectary.com/api/model-api/api-reference/removeobjects.md)
- [toggleVisibility](https://help.vectary.com/api/model-api/api-reference/togglevisibility.md)
- [selectObjects](https://help.vectary.com/api/model-api/api-reference/selectobjects.md)
- [deselectObjects](https://help.vectary.com/api/model-api/api-reference/deselectobjects.md)
- [getSelectedObjects](https://help.vectary.com/api/model-api/api-reference/getselectedobjects.md)
- [configureGizmo](https://help.vectary.com/api/model-api/api-reference/configuregizmo.md)
- [getHoveredObjects](https://help.vectary.com/api/model-api/api-reference/gethoveredobjects.md)
- [duplicateObjects](https://help.vectary.com/api/model-api/api-reference/duplicateobjects.md)
- [moveObjects](https://help.vectary.com/api/model-api/api-reference/moveobjects.md)
- [getPosition](https://help.vectary.com/api/model-api/api-reference/getposition.md)
- [setPosition](https://help.vectary.com/api/model-api/api-reference/setposition.md)
- [getRotation](https://help.vectary.com/api/model-api/api-reference/getrotation.md)
- [setRotation](https://help.vectary.com/api/model-api/api-reference/setrotation.md)
- [getScale](https://help.vectary.com/api/model-api/api-reference/getscale.md)
- [setScale](https://help.vectary.com/api/model-api/api-reference/setscale.md)
- [getPrimitives](https://help.vectary.com/api/model-api/api-reference/getprimitives.md)
- [setPrimitives](https://help.vectary.com/api/model-api/api-reference/setprimitives.md)
- [createBox](https://help.vectary.com/api/model-api/api-reference/createbox.md)
- [createSphere](https://help.vectary.com/api/model-api/api-reference/createsphere.md)
- [createCone](https://help.vectary.com/api/model-api/api-reference/createcone.md)
- [createCylinder](https://help.vectary.com/api/model-api/api-reference/createcylinder.md)
- [createTorus](https://help.vectary.com/api/model-api/api-reference/createtorus.md)
- [createTube](https://help.vectary.com/api/model-api/api-reference/createtube.md)
- [createPolyhedron](https://help.vectary.com/api/model-api/api-reference/createpolyhedron.md)
- [createPlane](https://help.vectary.com/api/model-api/api-reference/createplane.md)
- [setBooleanEnabled](https://help.vectary.com/api/model-api/api-reference/setbooleanenabled.md)
- [getBooleanEnabled](https://help.vectary.com/api/model-api/api-reference/getbooleanenabled.md)
- [setBooleanChildOperation](https://help.vectary.com/api/model-api/api-reference/setbooleanchildoperation.md)
- [getBooleanChildOperation](https://help.vectary.com/api/model-api/api-reference/getbooleanchildoperation.md)
- [getText3d](https://help.vectary.com/api/model-api/api-reference/gettext3d.md)
- [setText3d](https://help.vectary.com/api/model-api/api-reference/settext3d.md)
- [getAllMaterials](https://help.vectary.com/api/model-api/api-reference/getallmaterials.md)
- [getMaterials](https://help.vectary.com/api/model-api/api-reference/getmaterials.md)
- [getActiveMaterial](https://help.vectary.com/api/model-api/api-reference/getactivematerial.md)
- [setActiveMaterial](https://help.vectary.com/api/model-api/api-reference/setactivematerial.md)
- [addOrEditMaterial](https://help.vectary.com/api/model-api/api-reference/addoreditmaterial.md)
- [removeMaterial](https://help.vectary.com/api/model-api/api-reference/removematerial.md)
- [getTextureData](https://help.vectary.com/api/model-api/api-reference/gettexturedata.md)
- [setTextureData](https://help.vectary.com/api/model-api/api-reference/settexturedata.md)
- [addTexture](https://help.vectary.com/api/model-api/api-reference/addtexture.md)
- [mapTextures](https://help.vectary.com/api/model-api/api-reference/maptextures.md)
- [raycastAll](https://help.vectary.com/api/model-api/api-reference/raycastall.md)
- [raycastObject](https://help.vectary.com/api/model-api/api-reference/raycastobject.md)
- [getRayFromCoordinate](https://help.vectary.com/api/model-api/api-reference/getrayfromcoordinate.md)
- [getAnimations](https://help.vectary.com/api/model-api/api-reference/getanimations.md)
- [playAnimation](https://help.vectary.com/api/model-api/api-reference/playanimation.md)
- [stopAnimation](https://help.vectary.com/api/model-api/api-reference/stopanimation.md)
- [setAnimationPlayhead](https://help.vectary.com/api/model-api/api-reference/setanimationplayhead.md)
- [rotateEnvironmentMap](https://help.vectary.com/api/model-api/api-reference/rotateenvironmentmap.md)
- [getViewState](https://help.vectary.com/api/model-api/api-reference/getviewstate.md)
- [setViewState](https://help.vectary.com/api/model-api/api-reference/setviewstate.md)
- [fitToView](https://help.vectary.com/api/model-api/api-reference/fittoview.md)
- [takeScreenshot](https://help.vectary.com/api/model-api/api-reference/takescreenshot.md)
- [importFiles](https://help.vectary.com/api/model-api/api-reference/importfiles.md)
- [importProject](https://help.vectary.com/api/model-api/api-reference/importproject.md)
- [exportFile](https://help.vectary.com/api/model-api/api-reference/exportfile.md)
- [Ecommerce](https://help.vectary.com/api/model-api/ecommerce.md): Ecommerce platform and custom code integrations with Vectary embeds
- [Webflow](https://help.vectary.com/api/model-api/ecommerce/webflow.md)
- [Shopify](https://help.vectary.com/api/model-api/ecommerce/shopify.md)
- [Custom code](https://help.vectary.com/api/model-api/ecommerce/custom-code.md)
- [API Demos](https://help.vectary.com/api/model-api/api-demos.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.vectary.com/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.