Simplio3D API Reference
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.
IntroductionOverview of the Simplio3D REST API — base URL, JSON conventions, JWT authentication, and a quick example request.AuthenticationAuthenticate API requests with JWT bearer tokens or an X-API-Key, plus the public share-viewer credentials.ProjectsCreate, read, update, delete, and clone 3D configurator projects and their scene data.Option BlocksManage the 16 option block types and their variants — dropdowns, material swatches, toggles, inputs, modular, and more.Conditional LogicDefine show / hide / disable rules that react to selections, including 3D object and part targeting.Pricing & CPQConfigure CPQ pricing — base prices, price groups, 1D/2D tables, unique modular prices, variables, and formulas.Contact FormsBuild and read contact forms and their 12 field types for lead capture and add-to-cart flows.3D ViewerDrive the 3D viewer — camera, lighting, scene presets, and runtime configuration selections.AnimationsCreate and play animation blocks: move, rotate, float, scale-pulse, swing, and orbit.Project SettingsRead and update the 140+ project settings covering display, branding, AR, e-commerce, email, and PDF.AssetsUpload, list, update, delete, and download 3D model, texture, and image assets.MaterialsCreate and manage PBR materials and their texture maps.CategoriesOrganize assets and materials into categories for filtering and bulk material blocks.Team ManagementInvite, update, and remove team members on an account.Project SharingEnable project sharing, manage share tokens, and access the public share endpoint.Email & LogsSend test emails, list email logs, and resend failed notifications.API TokensGenerate, retrieve, and rotate API tokens for headless SDK access.Quote SubmissionsList and manage quote and contact-form submissions received from configurators.WebhooksRegister webhooks for quote.submitted, form.submitted, option.changed, and configuration.saved events.Augmented RealityExport USDZ, launch AR experiences, and read AR analytics.ChangelogVersion history and notable changes to the Simplio3D API.
