# pdf noodle Documentation

## Docs

- [Overview](https://docs.pdfnoodle.com/api-reference/index.md): Welcome to PDF Noodle API Reference
- [Authentication](https://docs.pdfnoodle.com/api-reference/getting-started/authentication.md)
- [Rate limit](https://docs.pdfnoodle.com/api-reference/getting-started/rate-limit.md)
- [Synchronous request](https://docs.pdfnoodle.com/api-reference/generate-pdf-from-template/synchronous.md): Synchronous means that when calling the API the request will wait for the pdf file to be generated before returning a response.
- [Asynchronous request](https://docs.pdfnoodle.com/api-reference/generate-pdf-from-template/asynchronous.md): Asynchronous means that the request will return immediately with a requestId (if the request passes validation), but the pdf file will be sent after a few seconds to your custom webhook.
- [Batch Request](https://docs.pdfnoodle.com/api-reference/generate-pdf-from-template/batch.md): Generate multiple PDFs from templates in a single request. Process up to 20 PDFs at once, with optional merging into a single file.
- [Synchronous request](https://docs.pdfnoodle.com/api-reference/convert-html-to-pdf/synchronous.md): Synchronous means that when calling the API the request will wait for the pdf file to be generated before returning a response.
- [Asynchronous Request](https://docs.pdfnoodle.com/api-reference/convert-html-to-pdf/asynchronous.md): Asynchronous means that the request will return immediately with a requestId (if the request passes validation), but the pdf file will be sent after a few seconds to your custom webhook.
- [Batch Request](https://docs.pdfnoodle.com/api-reference/convert-html-to-pdf/batch.md): Convert multiple HTML documents to PDFs in a single request. Process up to 20 PDFs at once, with optional merging into a single file.
- [Get PDF Status](https://docs.pdfnoodle.com/api-reference/pdf-status/get.md): Retrieve the status of a PDF generation request using the requestId returned from asynchronous requests or when synchronous requests timeout.
- [Get Batch PDF Status](https://docs.pdfnoodle.com/api-reference/pdf-status/get-batch.md): Retrieve the status of a batch PDF generation request using the batchRequestId.
- [Get Tool Status](https://docs.pdfnoodle.com/api-reference/tools/get-tool-status.md): Retrieve the status of a tool operation using the requestId returned when using async mode or when a synchronous request times out.
- [Get Signed Upload URL](https://docs.pdfnoodle.com/api-reference/tools/get-signed-upload-url.md): Generate a pair of presigned URLs: one for uploading a PDF file to temporary storage and one for downloading it.
- [Merge PDFs](https://docs.pdfnoodle.com/api-reference/tools/merge-pdfs.md): Combine two or more PDF files into a single document. The PDFs are merged in the order they are provided.
- [Split PDF](https://docs.pdfnoodle.com/api-reference/tools/split-pdf.md): Split a single PDF file into multiple smaller PDFs. You can split by specific page ranges or at regular intervals.
- [Compress PDF](https://docs.pdfnoodle.com/api-reference/tools/compress-pdf.md): Compress a PDF file to reduce its size. Choose between three compression levels depending on your quality requirements.
- [Convert Markdown to PDF](https://docs.pdfnoodle.com/api-reference/tools/convert-markdown-to-pdf.md): Convert Markdown text into a beautifully styled PDF document. Supports full Markdown syntax including headings, lists, tables, code blocks with syntax highlighting, and more.
- [Update PDF Metadata](https://docs.pdfnoodle.com/api-reference/tools/update-pdf-metadata.md): Update the embedded metadata of a PDF file, such as title, author, subject, keywords, and more. The original PDF content is preserved.
- [Create Template with AI](https://docs.pdfnoodle.com/api-reference/templates/create-template.md): Creates a new template using AI based on a text prompt and optional file reference. This is an asynchronous operation that typically takes a couple of minutes to complete.
- [List Templates](https://docs.pdfnoodle.com/api-reference/templates/list-templates.md): Retrieves a list of all templates available for the authenticated company.
- [Get Template Variables](https://docs.pdfnoodle.com/api-reference/templates/get-template-variables.md): Retrieves the variable schema for a specific template. This endpoint extracts all variables (data placeholders) that can be used when rendering the template.
- [Get Template](https://docs.pdfnoodle.com/api-reference/templates/get-template.md): Retrieves the complete template details, including its structure, components, and metadata. This endpoint can also be used to check the status of a template that is currently being created.
- [How render PNG instead of PDF](https://docs.pdfnoodle.com/api-reference/options/how-render-png-instead-of-pdf.md)
- [Storage Options (s3)](https://docs.pdfnoodle.com/api-reference/options/storage-options-s3.md)
- [PDF Params](https://docs.pdfnoodle.com/api-reference/options/pdf-params.md)
- [PDF metadata](https://docs.pdfnoodle.com/api-reference/options/pdf-metadata.md)
- [Debug Mode](https://docs.pdfnoodle.com/api-reference/options/debug-mode.md)
- [Migration guide: from pdforge to pdf noodle](https://docs.pdfnoodle.com/api-reference/guides/migration-guide-from-pdforge-to-pdf-noodle.md)
- [Knowledge Base](https://docs.pdfnoodle.com/knowledge-base/index.md): Welcome to the PDF Noodle Knowledge Base. Learn how to use the platform, build templates, and configure your account.
- [Overview](https://docs.pdfnoodle.com/knowledge-base/platform/quickstart.md)
- [Creating your account](https://docs.pdfnoodle.com/knowledge-base/platform/creating-your-account.md)
- [User authentication](https://docs.pdfnoodle.com/knowledge-base/platform/user-authentication.md)
- [Teammates management](https://docs.pdfnoodle.com/knowledge-base/platform/teammates-management.md)
- [Template builder](https://docs.pdfnoodle.com/knowledge-base/platform/template-builder.md)
- [Subscription management](https://docs.pdfnoodle.com/knowledge-base/platform/subscription-management.md)
- [PDF Tools Usage & Plan Limits](https://docs.pdfnoodle.com/knowledge-base/platform/pdf-tools-usage.md): Understand how PDF tool operations are tracked and how they count toward your plan's usage quota.
- [Saving to your S3 storage](https://docs.pdfnoodle.com/knowledge-base/guides/saving-to-your-s3-storage.md)
- [Embedding the template builder in your application](https://docs.pdfnoodle.com/knowledge-base/guides/embedding-the-template-builder-in-your-application.md)
- [Introduction](https://docs.pdfnoodle.com/knowledge-base/components/introduction.md): One of the most important parts of pdf noodle is our opinionated no-code template builder. With it, you can create stunning reports using our pre-designed components, allowing you to focus less on minor details and more on achieving a polished, professional result.
- [PDF Styling](https://docs.pdfnoodle.com/knowledge-base/components/pdf-styling.md): Here's where you'll configure your PDF styling, setting up global configurations such as:
- [Text](https://docs.pdfnoodle.com/knowledge-base/components/text.md): Our flexible Text component is designed for any text content you want to include in your template. Unlike other components, you'll edit the text directly on the canvas preview for a more intuitive experience.
- [HTML](https://docs.pdfnoodle.com/knowledge-base/components/html.md): Our HTML component was designed so you have the maximum flexibility to build your own components on the exact way you want. To have a better view on the code editor and the component itself, you can double click on the preview canvas.
- [Image](https://docs.pdfnoodle.com/knowledge-base/components/image.md): The Image Component lets you easily add images to your templates—either dynamically or statically.
- [Icon](https://docs.pdfnoodle.com/knowledge-base/components/icon.md): Our Icon Component lets you easily pick and insert icons from our integrated [**Lucide Icons**](https://lucide.dev/) **library.**
- [Markdown](https://docs.pdfnoodle.com/knowledge-base/components/markdown.md): Our Markdown component lets you work with both dynamic markdown strings (passed in the payload) or static markdown.
- [Container](https://docs.pdfnoodle.com/knowledge-base/components/container.md): The container component is one of pdf noodle key features, giving you superpowers to make your template look exactly how you want it. It's super flexible, allowing you to craft even complex layouts without ever needing to write a line of code.
- [Loop](https://docs.pdfnoodle.com/knowledge-base/components/loop.md): The Loop component lets you easily repeat a layout based on dynamic data.
- [Page Break](https://docs.pdfnoodle.com/knowledge-base/components/page-break.md): The Page Break component ensures precise control over how your document flows during PDF generation. It automatically forces a page break (page-break-before: always), so you can decide exactly where a new page should begin. This is especially useful for separating sections like chapters, invoices, o…
- [Divider](https://docs.pdfnoodle.com/knowledge-base/components/divider.md): The Divider component is a simple but effective way to visually separate sections of your document. It helps improve readability by clearly marking boundaries between content blocks in your PDF.
- [Table](https://docs.pdfnoodle.com/knowledge-base/components/table.md): Our table component lets you list dynamic items without writing loops or extra HTML. It's designed to help you create the perfect table for your document.
- [Metrics](https://docs.pdfnoodle.com/knowledge-base/components/metrics.md): The Metrics component is perfect for displaying KPIs or highlights inside your PDF templates. With it, you can quickly show numbers, icons, and subtitles, ideal for reports, dashboards, or performance summaries.
- [Charts](https://docs.pdfnoodle.com/knowledge-base/components/charts.md): Visualize metrics beautifully and fast. The Chart component lets you add six chart types, bind them to dynamic data, and fine-tune design details. Perfect for KPIs, trends, and comparisons in your PDFs.
- [Configuring Amazon S3](https://docs.pdfnoodle.com/knowledge-base/configuring-s3/configuring-amazon-s3.md)
- [Configuring Google Cloud Storage](https://docs.pdfnoodle.com/knowledge-base/configuring-s3/configuring-google-cloud-storage.md)
- [Configuring Supabase Storage](https://docs.pdfnoodle.com/knowledge-base/configuring-s3/configuring-supabase-storage.md)
- [SDKs](https://docs.pdfnoodle.com/sdks/index.md): Official client libraries for the pdf noodle API
- [Node.js](https://docs.pdfnoodle.com/sdks/nodejs.md): Official Node.js SDK for the pdf noodle API
- [MCP Integration](https://docs.pdfnoodle.com/integrations/mcp/index.md): Connect AI assistants to pdf noodle using the Model Context Protocol
- [Setup Guide](https://docs.pdfnoodle.com/integrations/mcp/setup.md): Step-by-step instructions to configure pdf noodle MCP for your AI assistant
- [Tools Reference](https://docs.pdfnoodle.com/integrations/mcp/tools.md): Complete reference for all pdf noodle MCP tools
- [Examples](https://docs.pdfnoodle.com/integrations/mcp/examples.md): Real-world prompts and use cases for pdf noodle MCP
- [PDF Best Practices Skill](https://docs.pdfnoodle.com/integrations/mcp/best-practices.md): Comprehensive guidelines for creating HTML that renders perfectly as PDF
- [n8n Integration](https://docs.pdfnoodle.com/integrations/n8n/index.md): Automate PDF generation workflows by connecting n8n with pdf noodle
- [Make Integration](https://docs.pdfnoodle.com/integrations/make/index.md): Automate PDF generation workflows by connecting Make with pdf noodle
- [Zapier Integration](https://docs.pdfnoodle.com/integrations/zapier/index.md): Automate PDF generation workflows by connecting Zapier with pdf noodle
- [Bubble Integration](https://docs.pdfnoodle.com/integrations/bubble/index.md): Generate PDFs in your Bubble app using pdf noodle