# Quick Start ### Prerequisites * Vectary project (create one at [vectary.com](https://www.vectary.com)) * **Business** plan * Basic knowledge of HTML and JavaScript {% stepper %} {% step %} ### Step 1: Get your Project ID * Open your project in Vectary Studio * Click **Share** in the top right corner * Copy the **Project ID** from the embed URL: ``` https://app.vectary.com/p/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx └──────────── Project ID ────────────┘ ``` {% endstep %} {% step %} ### Step 2: Add the embed to your page Create an HTML file with an iframe pointing to your project: ```html Vectary API Demo ``` Replace `YOUR_PROJECT_ID` with the ID from **Step 1** {% endstep %} {% step %} ### Step 3: Initialize the API Add this script after the iframe: ```html ``` Open your browser's console - you should see "API ready!" once the model loads. {% endstep %} {% step %} ### Step 4: Make your first API call The API provides many methods to control the scene (see the full list in the [API Reference](/api/model-api/api-reference.md)). Here's a simple example to get you started: ```html ``` #### Complete example Here's a full working example that lists all objects in the scene: ```html Vectary API Demo

My 3D Configurator

Scene Objects

Loading...
``` {% endstep %} {% endstepper %} ### Key points
PointDetails
One API instance per iframeIf you have multiple embeds, create a separate VctrModelApi for each
All methods are asyncAlways use await or .then() - methods return Promises
Initialize before calling methodsWait for api.init() to complete before making other calls
Error handlingErrors reject the Promise with { status: "error", error?: string }
### Troubleshooting **API not initializing?** * Check that the iframe `id` matches the string passed to `VctrModelApi()` * Ensure the project is published and accessible * Verify your workspace has a Business plan **Methods returning empty results?** * Make sure `init()` has completed before calling other methods * Check the browser console for error messages **CORS errors?** * The API script must be loaded from `app.vectary.com`, not copied locally ### Next steps * [**Core Concepts**](/api/model-api/core-concepts.md) - understand Variants, Materials, Events, and Variables * [**API Reference**](/api/model-api/api-reference.md) - explore all available methods * [**Ecommerce**](/api/model-api/ecommerce.md) - see integration patterns for online stores --- # Agent Instructions: 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/model-api/quick-start.md?ask= ``` 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.