Introduction

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

Base URL

https://api.iyzpdf.com/v1

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.

Current authenticated limits from the backend configuration:

Metadata shape:

{
  "fileName": "output.pdf",
  "size": 245812,
  "creditsUsed": 1,
  "creditsRemaining": 49,
  "contentType": "application/pdf"
}

Header	Meaning
`X-Request-Id`	Request identifier for support and debugging
`X-Processing-Time-Ms`	End-to-end processing time
`X-Credits-Used`	Credits consumed by the request
`X-Credits-Remaining`	Remaining balance after the request
`X-RateLimit-Limit`	Current minute-level limit
`X-RateLimit-Remaining`	Remaining requests in the current window
`X-RateLimit-Reset`	Unix timestamp for the next reset
`X-Pdf-Engine`	Returned by PDF editing operations
`X-Original-Size`	Returned by PDF compression
`X-Compressed-Size`	Returned by PDF compression
`X-Compression-Ratio`	Returned by PDF compression

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "A PDF file and pages array are required."
  }
}

Credit-related errors can also include:

Endpoint	Request type	Output	Credits
`POST /convert/html-to-pdf`	JSON or multipart	PDF	1 or 2
`POST /convert/markdown-to-pdf`	JSON or multipart	PDF	1
`POST /convert/word-to-pdf`	Multipart	PDF	2
`POST /convert/excel-to-pdf`	Multipart	PDF	2
`POST /convert/csv-to-pdf`	Multipart	PDF	1
`POST /convert/xml-to-html`	JSON or multipart	HTML	1
`POST /pdf/merge`	Multipart	PDF	1
`POST /pdf/pages/remove`	Multipart	PDF	1
`POST /pdf/compress`	Multipart	PDF	2

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