Jump to Content
Home
Guides
Recipes
Documentation
Changelog
v2.81
Log In
Discussions
Documentation
Log In
Discussions
v2.81
Home
Guides
Recipes
Documentation
Changelog
Player API
All
Pages
Start typing to search…
JUMP TO
Getting Started
Introduction
Client Side
Classic Player
Embedding the Threekit Player
Threekit iOS SDK
Player API
Unload Player
Set Active Camera
Save Configuration
Snapshot
Image Upload
Camera
Events
Languages & Translations
Scene
Selection
Tools
Connectors
Prefetcher
Configurator API
Nested Configurators
Sandbox
Composable Player
Getting Started
Types
Components
Hooks
PostEffects
Snapshots
Composable Configurator
useConfigurator()
Analytics
Treble
Welcome
Getting Started
Starting a new Treble Project
Adding widgets to your player
Managing multiple products
Building your configurator form
Embedding your app in a website
Setting up your Threekit Player
Main Concepts
Best Practices
Threekit Credentials
Player Config
Folder Structure
Available Scripts
Treble React
Theme
Threekit Config
Hooks
Use Zoom
Use Attribute
Use Player Portal
Use Name
Use Nested Configurator
Use Player Loading Status
Use Configurator
Use Price
Use Snapshot
Use Metadata
Use Threekit Init Status
Use Product Cache
Components
Player
Threekit Provider
Treble App
Product Layout
Room Builder
Forms
Flat Form
Form Components
Strips
Upload
Tiles Group
Tiles
Cards
Widgets
Share
Zoom
Snapshots
Display
Total Price
Product Name
Attribute Value
Attribute Title
Product Description
Wrappers
Await Threekit Load
Portal to Element
Layouts
Modal
Tabs
Accordion
Drawer
Treble JS API
server Side
REST API
Analytics
Create Event
post
Get Event by ID
get
Get Analytics for Events
get
Generate Reports for Buyer Analytics
get
Assets & Catalog - Simple
Get Assets
get
Get Asset by ID
get
Update Asset
put
Delete an Asset
del
Get Asset Details by ID
get
Get Tags
get
Get Keywords
get
Clone an Asset
post
Restore an Asset
post
Assets & Catalog - Granular
Create Assets
post
Get Catalog
get
Get Asset by ID
get
Overwrite Asset
put
Update Asset
patch
Delete Asset
del
Create Global Attribute
post
Get Global Attribute by ID
get
Update Global Attribute
put
Update Global Attribute
patch
Delete Attribute
del
Create an Attribute on Asset
post
Get Asset Attribute
get
Update Attribute on Asset
put
Update Attribute on Asset
patch
Delete Attribute From Asset
del
Add Metadata to Asset
post
Get Metadata Entry on Asset
get
Overwrite Metadata on Asset
put
Update Metadata on Asset
patch
Delete Metadata on Asset
del
Assets & Catalog - Bulk
Create or Update Assets (file input)
post
Create or Update Assets (JSON input)
post
Export Asset List
get
Assets & Catalog - Legacy
Get Products
get
Get Product by ID
get
Get Job by ID
get
Upload Assets (Images)
post
Assets & Catalog - Import, Export, and Render Jobs
Import Assets
post
Export an Asset
post
Render an Asset with WebGL
post
Render an Asset with VRay
post
Render all Combinations of an Asset
post
Create Composites & Render Missing Layers
post
Export All Combinations
post
Job Results Download
post
Composite Layered Renders into Image
post
Get Asset Thumbnail PNG
get
Export Vector Paths
post
Catalog 2.0 - Items
Get All Items
get
Create Item
post
Get Item
get
Update Item
patch
Delete Item
del
Get Attributes of Item
get
Add Attribute to Item
post
Delete Attribute from Item
del
Catalog 2.0 - Attributes
Get All Attributes
get
Create Attribute
post
Get Attribute
get
Update Attribute
patch
Delete Attribute
del
Get Options of Attribute
get
Add Option to Attribute
post
Delete Option from Attribute
del
Catalog 2.0 - Options
Get All Options
get
Create Option
post
Get Option
get
Update Option
patch
Delete Option
del
Catalog 2.0 - Variants
Get Variants
get
Generate Variants
post
Get Variant
get
Update Variant
patch
Get Prices
get
Set Prices
put
Get Price by ID
get
Create/Update Price
put
Delete Price
del
Get Variant Content
get
Attach Content to a Variant
post
Get Variant Content by Content Key
get
Delete Variant Content by Content Key
del
Catalog 2.0 - AI Discovery
Get All Experiences
get
Create Experience
post
Get Experience
get
Update Experience
patch
Query Experience
post
Catalog 2.0 - Prompts
Get All Prompts
get
Create Prompt
post
Get Prompt
get
Update Prompt
patch
Create Prompt Version
post
Get All Prompt Versions
get
Catalog 2.0 - Bulk Management
Parse CSV Catalog to extract column names and total row count
post
Bulk Create Catalog
post
Catalog 2.0 - Transactions
Get Transactions
get
Create Transactions
post
Get Transaction by ID
get
Update Transaction
patch
Get Cart Details
get
Add or Update Item in Cart
post
Delete Item from Cart
del
Branches
Create Branch
post
Get Org Branches
get
Get Branch
get
Delete Branch
del
Get Branch Diffs
get
Merge branch
post
Data Tables
Create Datatable
post
Get All Datatables
get
Get a Datatable by ID
get
Update Datatable
put
Delete Datatable
del
Restore Datatable
post
Download Datatable
get
Get Row Value
get
Get List of Rows
get
Update Rows
post
Fast Compositor
Creates Composite Image
get
File Service
Upload Files
post
Get File by ID
get
Get Files Report
get
Jobs Service
Get Jobs
get
Get Job by ID
get
Retry Job
post
Cancel Job
post
Resume Job
post
Pause Job
post
Job Tasks
Get Tasks
get
Get Task by ID
get
Retry Task by ID
post
Job Runs
Get Runs
get
Get Run by ID
get
Get Run Reports
get
Layers Service (Renders & AR)
Get List of Layers
get
Create Layer
post
Get Layer by ID
get
Get Layer by Query Parameters
get
Get Layers in Groups by Query Parameters
post
Orders
Get Orders
get
Creates Order
post
Get Order by ID
get
Update Order
put
Add Items to Order
post
Remove Items from Order
put
Orgs
Get Public Orgs
get
Get Org by ID
get
PDF Service
Create PDF
post
Pricebooks
Create Pricebook
post
Get Pricebooks
get
Get Pricebook by ID
get
Update Pricebook
put
Delete Pricebook
del
Saved Configurations
Save Configuration
post
Get Configurations
get
Get Configurations by SKU
get
Get Configuration by ID/ShortID
get
Get Thumbnail of Configuration by ID/shortID
get
Get File Linked to Configuration
get
Tags
Create Tag
post
Get Tags
get
Get Tag by ID
get
Update Tag
put
Delete Tag
del
Restore Tag
post
Translations
Get Translations
get
Import Translations for Catalog Items.
post
Export Product Translations
get
Webhooks
REST API SDK
Connectors & Integrations
Introduction
Magento
Salesforce Lightning Web Components
Powered by
Player API
Ask AI
The root player API, from which all other modules are accessed.
