Skip to main content
Use this section when you need the shared contract before looking at an individual endpoint page.

​
Base URL

https://api.iyzpdf.com/v1

​
Authentication

All examples in this reference use API-key authentication: 
X-API-Key: iyz_live_your_key_here
Call the API from your backend or other trusted server environment.

​
Rate Limits

Current authenticated limits from the backend configuration:
  • 60 requests per minute when the account has available credits
  • 10 requests per minute when the account has zero credits
  • 10 requests per second burst with credits
  • 2 requests per second burst with zero credits

​
Default Success Behavior

  • Binary endpoints return a file attachment by default
  • POST /convert/xml-to-html returns HTML by default
  • Accept: application/json switches the response to metadata
Metadata shape: 
{
  "fileName": "output.pdf",
  "size": 245812,
  "creditsUsed": 1,
  "creditsRemaining": 49,
  "contentType": "application/pdf"
}

​
Shared Success Headers

HeaderMeaning
X-Request-IdRequest identifier for support and debugging
X-Processing-Time-MsEnd-to-end processing time
X-Credits-UsedCredits consumed by the request
X-Credits-RemainingRemaining balance after the request
X-RateLimit-LimitCurrent minute-level limit
X-RateLimit-RemainingRemaining requests in the current window
X-RateLimit-ResetUnix timestamp for the next reset
X-Pdf-EngineReturned by PDF editing operations
X-Original-SizeReturned by PDF compression
X-Compressed-SizeReturned by PDF compression
X-Compression-RatioReturned by PDF compression

​
Error Model

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "A PDF file and pages array are required."
  }
}
Credit-related errors can also include:
  • creditsRequired
  • creditsBalance
  • purchaseUrl

​
Endpoint Catalog

EndpointRequest typeOutputCredits
POST /convert/html-to-pdfJSON or multipartPDF1 or 2
POST /convert/markdown-to-pdfJSON or multipartPDF1
POST /convert/word-to-pdfMultipartPDF2
POST /convert/excel-to-pdfMultipartPDF2
POST /convert/csv-to-pdfMultipartPDF1
POST /convert/xml-to-htmlJSON or multipartHTML1
POST /pdf/mergeMultipartPDF1
POST /pdf/pages/removeMultipartPDF1
POST /pdf/compressMultipartPDF2

​
OpenAPI

This Mintlify bundle also includes a static OpenAPI file at openapi.json.