canonical: https://jentic.com/apis/ilovepdf.com/ilovepdf-ilovepdf

# iLovePDF API

iLovePDF API exposes the PDF and image processing tools from iLoveAPI as a programmatic service. Developers authenticate, start a task for a tool such as merge, split, compress, or convert, upload files to the assigned worker server, run the process, and download the result. The API also covers electronic signature workflows so PDFs can be sent for signing and the signed copies pulled back. It targets SaaS apps that need PDF transformations or signature flows without bundling a local toolchain.

## For AI agents

Run PDF and image processing tasks like merge, split, compress, convert, and electronic signature requests through iLovePDF's task-based pipeline.

## Scope

Does not handle PDF rendering in the browser, OCR text extraction, or document storage - use for PDF and image transformation tasks and electronic signature requests only.

## Capabilities

- Authenticate with project credentials and obtain a bearer token for subsequent calls
- Start a processing task for a specific tool such as merge, split, or compress
- Upload one or more files to the worker server assigned to a task
- Run a configured task and download the resulting PDF or image bundle
- Send a PDF out for electronic signature with one or more named signers
- Retrieve a signed PDF by token once all signers have completed

## Use cases

### PDF Generation Pipeline for SaaS

Back-office and customer-facing apps frequently need to merge, compress, or convert PDFs before emailing or storing them. iLovePDF's task model fits this well: start a task for the chosen tool, upload the source files, run the task, and download the output. The four-call pattern keeps long-running jobs off the main app server.

Example prompt: POST /auth to get a token, GET `/start/merge/{region}`, POST /{server}/v1/upload for each PDF, POST /{server}/v1/process, then GET /{server}/v1/download/{task}.

### Contract E-Signature Flow

Send sales or HR contracts for electronic signature without standing up a separate signing service. The signature endpoints accept signer details, route the document to each signer, and expose a download endpoint for the completed PDF. This works well for low-volume signing in apps that already use iLovePDF for document conversion.

Example prompt: POST /{server}/v1/signature with signer emails and the prepared PDF, then GET /{server}/v1/signature/{token}/download-signed once all parties have signed.

### Bulk Document Compression

Archival systems and email gateways often need to shrink PDFs before storage or delivery. Looping the start, upload, process, and download steps over a folder of files lets a job worker apply the compress tool at scale without a local PDF library. Worker server assignment per task keeps throughput predictable.

Example prompt: For each PDF in a queue: GET `/start/compress/{region}`, upload, process, then download and store the compressed output.

### Agent-Initiated Document Workflows

An AI assistant in an internal tool can accept a request like 'merge these three contracts and send the result for signature' and chain the iLovePDF operations behind one Jentic search. The agent does not need to know the task lifecycle - Jentic returns the right operations in order, with their input schemas, so the assistant can run the chain end to end.

Example prompt: Search Jentic for 'merge PDFs and send for signature', execute the merge chain, then execute the signature operation against the merged output.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth` | Authenticate and receive a bearer token |
| GET | `/start/{tool}/{region}` | Start a task for a tool and get the worker server |
| POST | `/{server}/v1/upload` | Upload a file to a started task |
| POST | `/{server}/v1/process` | Run the configured task |
| GET | `/{server}/v1/download/{task}` | Download the processed file bundle |
| POST | `/{server}/v1/signature` | Create an electronic signature request |
| GET | `/{server}/v1/signature/{token}/download-signed` | Download a signed PDF by token |

## Key resources

- **Auth** — Exchange project credentials for a bearer token.
- **Tasks** — Start, upload to, run, and download from per-tool tasks.
- **Signature** — Issue, list, and retrieve electronic signature requests on PDFs.

## Why Jentic

- **Setup:** Wiring iLovePDF by hand means exchanging project credentials for a bearer token, resolving the assigned processing server and region, and sequencing the upload, process, and download steps yourself. Through Jentic you install once, import the iLovePDF API from the API Directory, store the project credentials once, and your agent calls it.
- **Permission scoping:** iLovePDF works through a per-task lifecycle where the server and task travel in the path only after a task is started, so scope the agent to the operations it needs, such as start, upload, process, and download. Because you choose the allowed operations, an agent limited to conversions never gets the signature operations unless you add them.
- **Credential handling:** Your iLovePDF project credentials are stored once, encrypted, by your own Jentic One instance, and the short-lived bearer token is injected at execution time. The project secret never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'merge PDFs and download the result', and Jentic returns the start, upload, process, and download operations with their schemas so the agent calls the right endpoints without browsing the reference docs.

## Related APIs

- **PDF.co** — PDF.co offers a similar set of PDF transformation and extraction tools through a flat REST surface.
- **Cloudinary Upload API** — Cloudinary handles image and asset hosting and transformation alongside PDF generation.
- **PandaDoc** — PandaDoc is a fuller-featured contract and e-signature platform with templates and workflow.

## FAQ

### What authentication does the iLovePDF API use?

The API uses bearer token authentication. Call POST /auth with project credentials to receive a token, then send Authorization: Bearer {token} on subsequent requests. Through Jentic the project key stays in the encrypted vault and the bearer flow is handled automatically.

### Can I run an end-to-end PDF merge through this API?

Yes. Call /auth, then GET `/start/merge/{region}` to receive a worker server, POST each PDF to /{server}/v1/upload, POST /{server}/v1/process to execute the merge, and GET /{server}/v1/download/{task} to retrieve the merged file.

### Does the API support electronic signatures on PDFs?

Yes. POST /{server}/v1/signature creates a signature request with signer details, GET `/v1/signature/list` returns the requests on your account, and GET /{server}/v1/signature/{token}/download-signed returns the signed PDF once complete.

### How do I trigger a PDF compression through Jentic?

Run pip install jentic, search for 'compress a PDF with iLovePDF', then load and execute the start, upload, process, and download operations in order. Jentic chains the worker server URL across calls so the agent does not have to track it manually.

### What are the rate limits for the iLovePDF API?

The OpenAPI spec does not list explicit rate limits. iLovePDF enforces per-plan quotas on tasks per month and concurrent worker usage; consult your project dashboard and back off on HTTP 429 responses.

### Can I limit what my agent is allowed to do with the iLovePDF API?

Yes. Because Jentic One is self-hosted, you decide which iLovePDF operations your agent may call and which credentials it may use. You can scope an agent to only the PDF processing lifecycle, such as start, upload, process, and download, so it can merge, compress, or convert files but never reaches the signature operations. If you want the agent to send documents for e-signature, you add the signature and download-signed operations yourself, and the stored project credentials are only injected for the calls you have allowed.