How Carbone works — 3 steps:

𝗦𝘁𝗲𝗽 𝟭: 𝗗𝗲𝘀𝗶𝗴𝗻 𝘆𝗼𝘂𝗿 𝘁𝗲𝗺𝗽𝗹𝗮𝘁𝗲

Create a template in any editor (Word, LibreOffice, Excel, Google Docs) and insert Carbone markers — placeholders like {d.firstName} that get replaced with your data at render time. Markers can inject text, numbers, dates, images, barcodes, HTML content, dynamic loops, and more.

Alternatively, use Carbone Studio (https://studio.carbone.io) to upload your template, paste your JSON data, and preview the output live — no API calls needed during design. Supported template formats: DOCX, ODT, XLSX, ODS, PPTX, ODP, HTML, Markdown, and more.
→ Template design guide: https://carbone.io/documentation/design/overview/getting-started.html


𝗦𝘁𝗲𝗽 𝟮: 𝗨𝗽𝗹𝗼𝗮𝗱 𝘆𝗼𝘂𝗿 𝘁𝗲𝗺𝗽𝗹𝗮𝘁𝗲

Upload your template via "Upload a Template" action. You'll receive a unique template ID used to trigger renders. If you manage templates via Carbone Studio, you can copy the template ID directly from the Studio interface (top-right "info" icon).
You need an API key for all authenticated endpoints. Create a free account and get your key at: https://carbone.io


𝗦𝘁𝗲𝗽 𝟯: 𝗚𝗲𝗻𝗲𝗿𝗮𝘁𝗲 𝗮𝗻𝗱 𝗱𝗼𝘄𝗻𝗹𝗼𝗮𝗱 𝘆𝗼𝘂𝗿 𝗱𝗼𝗰𝘂𝗺𝗲𝗻𝘁

Call the action "Generate a Document" with your template ID and a JSON data payload. Specify the output format with "convertTo": "pdf" (or docx, xlsx, etc.) in the request body. The API returns the generated file directly — no extra download step needed.
→ Full render options reference: https://carbone.io/documentation/developer/http-api/introduction.html

🎉 Done! Your document is ready.

𝗔𝗣𝗜 𝗸𝗲𝘆 𝘁𝘆𝗽𝗲𝘀:
- 🧪 Test API key — generates unlimited watermarked PDFs only. Use for template design and testing.
- 🚀 Production API key — generates any format, no watermark. Based on your subscription credits.
- 🆓 Free Sandbox plan — includes 100 credits/month with a production key. Great for low-volume production use without a paid plan.

𝗗𝗮𝘁𝗮 𝗽𝗿𝗶𝘃𝗮𝗰𝘆:
- Carbone does not log or store the data you send to the Cloud API or Studio. Your data is used solely to generate the document.

𝗡𝗲𝗲𝗱 𝗵𝗲𝗹𝗽?
- Live support: https://go.crisp.chat/chat/embed/?website_id=189afeb5-0aef-4ca8-9b66-4f7951fc7d34
Stay updated:

𝗙𝗼𝗹𝗹𝗼𝘄 𝘂𝘀:
- Discord: https://discord.gg/kKB3aPYqnh
- Linkedin: https://www.linkedin.com/company/carboneio
- X: https://x.com/carbone_io


Cheers 🍻 The Carbone Team