> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iyzpdf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Client-facing API documentation for converting documents and editing PDFs with IyzPdf.

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:

```json theme={null}
{
  "fileName": "output.pdf",
  "size": 245812,
  "creditsUsed": 1,
  "creditsRemaining": 49,
  "contentType": "application/pdf"
}
```

## Supported Endpoints

| Category    | Endpoint                        | Output |
| ----------- | ------------------------------- | ------ |
| Conversion  | `POST /convert/html-to-pdf`     | PDF    |
| Conversion  | `POST /convert/markdown-to-pdf` | PDF    |
| Conversion  | `POST /convert/word-to-pdf`     | PDF    |
| Conversion  | `POST /convert/excel-to-pdf`    | PDF    |
| Conversion  | `POST /convert/csv-to-pdf`      | PDF    |
| Conversion  | `POST /convert/xml-to-html`     | HTML   |
| PDF Editing | `POST /pdf/merge`               | PDF    |
| PDF Editing | `POST /pdf/pages/remove`        | PDF    |
| PDF Editing | `POST /pdf/compress`            | PDF    |

## Next Steps

1. Open [Quickstart](quickstart) to make your first authenticated request.
2. Read [API Keys](guides/api-keys) to generate and manage production keys safely.
3. Use the [API Reference](api-reference/introduction) when you need field-level request details.