Skip to main content
IyzPdf exposes synchronous REST endpoints for document conversion and PDF editing. This documentation is written for SaaS clients who want to call the API from their own backend or trusted server environment.

Base URL

https://api.iyzpdf.com/v1

What This Documentation Covers

  • HTML, Markdown, Word, Excel, and CSV conversion
  • XML + XSLT transformation to HTML
  • PDF merge, page removal, and compression
  • API-key authentication
  • Request and response contracts
  • Copy-paste examples for cURL, PHP, .NET, Node.js, and Java

What Is Intentionally Out of Scope

  • Portal management APIs
  • Internal or benchmark endpoints
  • Anonymous usage flows
  • Frontend-only browser integrations that would expose your API key

Integration Model

All examples in this documentation send an X-API-Key header. Store the key on your server, call IyzPdf from your backend, and return the generated file or metadata to your own application.

Response Pattern

Most endpoints return a binary file by default:
  • application/pdf for PDF outputs
  • text/html for XML transformation output
If you send Accept: application/json, the API returns metadata instead of the generated file:
{
  "fileName": "output.pdf",
  "size": 245812,
  "creditsUsed": 1,
  "creditsRemaining": 49,
  "contentType": "application/pdf"
}

Supported Endpoints

CategoryEndpointOutput
ConversionPOST /convert/html-to-pdfPDF
ConversionPOST /convert/markdown-to-pdfPDF
ConversionPOST /convert/word-to-pdfPDF
ConversionPOST /convert/excel-to-pdfPDF
ConversionPOST /convert/csv-to-pdfPDF
ConversionPOST /convert/xml-to-htmlHTML
PDF EditingPOST /pdf/mergePDF
PDF EditingPOST /pdf/pages/removePDF
PDF EditingPOST /pdf/compressPDF

Next Steps

  1. Open Quickstart to make your first authenticated request.
  2. Read API Keys to generate and manage production keys safely.
  3. Use the API Reference when you need field-level request details.