Setting Up Configurators

Setting up 3D configurators for use with the Zea API.

Applicable to:

Zea Parts

Team Admins and Technicians

Overview

Configurators define which assemblies, parts, materials, and views can be toggled or updated in a 3D model through the Zea API.

They are prepared in the Configurator editor but require a developer integration to function. Zea provides the 3D setup and toggle logic; developers build the user interface and behavior using the API.

⁠

Prerequisites

Before creating a configurator, make sure:

A published Illustration Project is available (see See

Publish an Illustration⁠

Materials and Views are defined in the 3D model or illustration.

API access is configured in Organization Settings → API Keys.

⁠

Creating a New Configurator Project

Click the Configurators app from the Workspace Dashboard.

⁠

Click New Configurator.

Add a Project Name and click Create.

Browse for an Illustration Project to link (this must be set up first).

⁠

The configurator opens in the editor, showing your linked illustration in 3D. The editor is used to define which assemblies, parts, and views will be available to the API.

⁠

Adding Options and Configurations

Configurators can include Option Tags and Configurations (from CAD models) which can be toggled on and off.

⁠

1. Option Tags (Automatically Detected)

When you link an illustration, Zea automatically detects any Option Tags in the assemblies and adds matching options to the list.

See

Configuring Option Tags in 3D Models (Early Preview)⁠

⁠

Manage Option Tags in the 3D Models editor.

Manage Option Tags in the 3D Models editor.

⁠

2. Configurations (From CAD)

If your CAD model includes predefined configurations, you can add them manually. Configurations let you expose CAD-level variants as selectable options through the API.

Click Add Option.

Enter the part number in the dialog.

Click Create.

⁠

View configuration in the 3D Models browser or editor.

View configuration in the 3D Models browser or editor.

⁠

Views

Views defined in the linked illustration automatically appear in the configurator. These can be used to set camera positions in your integrated app.

⁠

Materials

Materials applied to assemblies in 3D Models or Illustrations are automatically imported into the configurator. They can later be referenced or updated through the API to support different finishes or colors.

⁠

Testing in the Editor

You can test your configurator setup directly inside the editor before connecting it to the API.

Toggle Options: Turn options or configurations on and off using the checkboxes to confirm assemblies respond correctly.

Select Views: Choose a view from the list to verify camera angles and visual states load properly.

Change Colors: Adjust material colors to confirm they update live on the 3D model.

These tests only affect the editor environment and help verify that all links and materials are configured correctly before integration.

⁠

Configuration toggled off

Configuration toggled off

⁠

Configuration toggled on

Configuration toggled on

⁠

Target View

The Target View shows the final 3D scene without any Zea UI.

It cannot be interacted with directly.

Developers embed this view and control it using the Zea API — for example, to show or hide parts, change materials, or switch views.

⁠

Using the Zea API

he Zea API is required to make a configurator functional. Developers use it to embed the Target View in a custom application and control it programmatically.

Go to Organization Settings → API Keys.

Enter a name and click Create API Key.

Use this key to authenticate your configurator integration.