Simplio3D API v3.4

Build powerful headless 3D CPQ applications with the Simplio3D RESTful API. Full control over option blocks, conditional logic, pricing, contact forms, 3D viewer, animations, and more.

Getting Started

The Simplio3D API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and JWT-based authentication.

Base URL: https://your-project.supabase.co/functions/v1/make-server-0532dd87

Quick Example

// Get all projects
const response = await fetch(BASE_URL + '/projects', {
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data.projects);

Available Endpoints

Authentication

4 endpoints

Projects

Full CRUD + model uploads

7 endpoints

Option Blocks

Configurator blocks CRUD + reorder

7 endpoints

Conditional Logic

Rules management + evaluation

4 endpoints

Pricing & CPQ

Price blocks, formulas, calculate

6 endpoints

Contact Forms

Form fields CRUD + submissions

5 endpoints

3D Viewer

Embed config, state, screenshots

5 endpoints

Animations

Animation blocks CRUD

4 endpoints

Project Settings

Branding, lighting, camera

3 endpoints

Assets

Upload, manage, download

6 endpoints

Materials

PBR materials CRUD

5 endpoints

Team

Invite, update, remove members

4 endpoints

Sharing

Public links & settings

5 endpoints

Email

SMTP test, logs, resend

5 endpoints

Quote Submissions

Submit, list, manage quotes

4 endpoints

Headless Architecture

Build your own UI with full API access to option blocks, conditional logic, pricing formulas, and 3D viewer state. Perfect for custom storefronts.

Secure by Default

JWT-based authentication with Supabase Auth. All mutating endpoints require a valid access token.

Authentication

The Simplio3D API uses JWT tokens for authentication. All API requests must include a valid access token.

Sign Up

POST/auth/signup

const response = await fetch(BASE_URL + '/auth/signup', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    email: '[email protected]',
    password: 'securePassword123',
    name: 'John Doe'
  })
});

const data = await response.json();
// { "success": true, "userId": "...", "message": "Account created" }

Sign In

import { createClient } from '@supabase/supabase-js';

const supabase = createClient(SUPABASE_URL, SUPABASE_ANON_KEY);

const { data: { session }, error } = await supabase.auth.signInWithPassword({
  email: '[email protected]',
  password: 'securePassword123'
});

// Use session.access_token for all API calls
const accessToken = session.access_token;

Get Session

GET/auth/session

const response = await fetch(BASE_URL + '/auth/session', {
  headers: { 'Authorization': 'Bearer ' + accessToken }
});

const data = await response.json();
// { "success": true, "userId": "...", "email": "[email protected]" }

Using Access Tokens

Include the access token in the Authorization header for all authenticated requests:

Authorization: Bearer YOUR_ACCESS_TOKEN

Projects

Manage 3D projects and configurations. Project types include configurator, viewer, cpq, ar-preview, and embedded.

List All Projects

GET/projects

const response = await fetch(BASE_URL + '/projects', {
  headers: { 'Authorization': 'Bearer ' + accessToken }
});

const data = await response.json();
// {
//   "success": true,
//   "projects": [
//     {
//       "id": "proj_123",
//       "name": "Modern Office Design",
//       "type": "configurator",
//       "thumbnail": "https://...",
//       "createdAt": "2026-02-25T10:00:00Z",
//       "updatedAt": "2026-03-01T14:30:00Z"
//     }
//   ]
// }

Create Project

POST/projects

const response = await fetch(BASE_URL + '/projects', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + accessToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'New Product Configuration',
    type: 'configurator' // 'configurator' | 'viewer' | 'cpq' | 'ar-preview' | 'embedded'
  })
});

const data = await response.json();
// { "success": true, "project": { ... } }

Get Project

GET/projects/:id

Large projects may return an optimized payload variant to stay within edge gateway limits. Always handle both full and compressed response shapes.

const response = await fetch(BASE_URL + '/projects/proj_123', {
  headers: { 'Authorization': 'Bearer ' + accessToken }
});
const data = await response.json();

// Variant A (full / normalized scene)
// data.project.sceneData

// Variant B (optimized)
// data.project.data.sceneDataCompressed + data.project.data.sceneDataEncoding
// OR data.project.data.sceneData + data.project.data.models + data.project.data.camera

Large-Project Response Variants

The API may return one of these variants for GET /projects/:id:

• project.sceneData (fully expanded scene)
• project.data.sceneDataCompressed + sceneDataEncoding=gzip-base64
• project.data.sceneData with project.data.models and project.data.camera

Update Project

PUT/projects/:id

const response = await fetch(BASE_URL + '/projects/proj_123', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer ' + accessToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Updated Project Name',
    data: { settings: { autoRotate: true } }
  })
});

Duplicate Project

POST/projects/:id/clone

Creates an independent copy by deep-cloning the project's entire sceneData — all 3D models (with nested groups and parts), every option block and variant (hotspots, scenery, materials, …), the full pricing structure (price groups, 1D/2D tables, unique-price blocks, variables, and all SKU maps), the complete form, animations, conditional logic, and project settings. Asset-library models, materials, and textures are reused by reference (no extra storage cost). Per-project uploaded models, the AR USDZ file, and the thumbnail are copied to the new project's storage path and their stored paths rewritten so the copy is independent of the source. Share settings, WooCommerce / Shopify product links, and saved configurations are not carried over.
Plan gate: requires Pro or Enterprise. Starter callers receive 403.

const response = await fetch(BASE_URL + '/projects/proj_123/clone', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + accessToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'My Configurator Copy'   // optional — defaults to "{source name} Copy"
  })
});

const data = await response.json();
// {
//   "success": true,
//   "project": { "id": "proj_new", "name": "My Configurator Copy", "type": "configurator", ... },
//   "warnings": { "failedModelCopies": [...], "message": "..." }   // present only on partial failure
// }

Delete Project

DELETE/projects/:id

const response = await fetch(BASE_URL + '/projects/proj_123', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer ' + accessToken }
});

Option Blocks

Option blocks are the core configurator building blocks. Each block type represents a different UI control that drives 3D model changes, material swaps, visibility toggles, and more. Supports 15 block types for headless integration.

Supported Block Types

dropdown

select-material

thumbnail-selector

checkbox

toggle-switch

carousel

text-input

number-input

file-upload

pattern-designer

design-canvas

hotspot

fixed-material

section-header

scenery

Select Material — authoring modes

The select-material block exposes two authoring modes via a top-level materialSource field:

Manual (materialSource: 'manual', default) — variants are authored individually in dropdownVariants, each with its own target, material, and pricing. Supports Price Group / Variable / Price Table linking.
From Category (materialSource: 'category') — runtime variants are auto-populated from every material inmaterialCategoryId. The block uses a shared target that can span multiple objects — categoryTargetObjectIds (string[]) and per-model categoryTargetParts (Record<modelId, string[]>) — applied to every synthesized variant (legacy single-object categoryTargetObjectId /categoryTargetPartNames are still read as a fallback). Pricing flows through the standard Pricing system (Price Group / Variable / Price Table / Unique Price) — link a pricing block to the category-mode Select Material block and author one price per material. Variant IDs at runtime are auto:{materialId}.

Public share viewers fetch referenced category materials at first paint via GET /share/:projectId/:token/category-materials?ids=cat1,cat2, with GET /share/:projectId/:token/category-materials/:categoryId still available for a single category.