Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Detailed specifications for each visualisation output format supported by the API.
mutation { renderVisualisation(input: { productId: "prod_abc123" format: MP4 template: IMPACT_CERTIFICATE parameters: { resolution: "1920x1080" fps: 30 duration: 10000 branding: { logo: true, colors: "custom", primaryColor: "#F83B00" } } }) { url format fileSize duration expiresAt } }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: AFTER_EFFECTS template: SOCIAL_SHARE_VIDEO parameters: { templateId: "ae_tmpl_impact_story" dataMapping: { productName: "{{product.name}}" co2Score: "{{product.impactScore.co2Equivalent}}" equivalency: "{{product.impactScore.equivalencies[0].description}}" } } }) { url renderJobId status estimatedCompletion } }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: LOTTIE template: SCORE_GAUGE }) { parameters templateUrl } }
{ "parameters": { "score": 87, "maxScore": 100, "label": "Sustainability Score", "color": "#4CAF50", "segments": [ { "name": "Materials", "value": 45, "color": "#2196F3" }, { "name": "Transport", "value": 25, "color": "#FF9800" }, { "name": "Production", "value": 17, "color": "#9C27B0" } ] }, "templateUrl": "https://assets.heychocolate.com/lottie/score-gauge.json" }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: RIVE template: IMPACT_DASHBOARD }) { parameters templateUrl stateMachineInputs } }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: THREEJS template: SUPPLY_CHAIN_GLOBE }) { sceneData { nodes { id position label value } edges { from to weight } camera { position lookAt } } } }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: SPLINE template: PRODUCT_CONFIGURATOR }) { sceneUrl variables { name type value } } }
mutation { renderVisualisation(input: { productId: "prod_abc123" format: UNICORN_STUDIO template: PARTICLE_IMPACT }) { embedCode parameters } }
SCORE_GAUGE
IMPACT_BREAKDOWN
IMPACT_CERTIFICATE
SUPPLY_CHAIN_GLOBE
PRODUCT_CONFIGURATOR
COMPARISON_CHART
SOCIAL_SHARE_VIDEO
PARTICLE_IMPACT
CARBON_BADGE