---
canonical_url: "https://docs.composio.dev/toolkits/i_love_pdf"
markdown_url: "https://docs.composio.dev/toolkits/i_love_pdf.md"
product: "platform"
version: null
last_updated: null
---

# iLovePDF

iLovePDF provides APIs for processing, converting, optimizing, and signing PDF and image files.

- **Category:** documents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `I_LOVE_PDF`
- **Version:** 00000000_00

## Tools

### Compress Images

**Slug:** `I_LOVE_PDF_COMPRESS_IMAGES`

Compress one or more images and immediately return the resulting image or ZIP as an offloaded download. This operation consumes processing credits and cleans up the provider task by default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | Yes | Image files to compress, in processing order. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction: eu, us, fr, de, pl, in, or sg. |
| `keep_task` | boolean | No | Keep the provider task after the output is safely offloaded. |
| `packaged_filename` | string | No | Optional ZIP filename when multiple outputs are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compress PDFs

**Slug:** `I_LOVE_PDF_COMPRESS_PDFS`

Compress one or more PDFs and return the stored PDF or ZIP output in one workflow: task creation, ordered uploads, synchronous processing, download, and best-effort cleanup. This operation consumes iLovePDF processing credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | Yes | PDF files to compress, in processing order. At least one file is required. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction; omit for automatic routing. |
| `password` | string | No | Password to use for every encrypted source PDF in this batch. |
| `keep_task` | boolean | No | Keep the provider task after the result is safely stored. False deletes the task to avoid the provider's open-task limit. |
| `output_filename` | string | No | Optional output filename template supported by iLovePDF. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Images to PDF

**Slug:** `I_LOVE_PDF_CONVERT_IMAGES_TO_PDF`

Convert one or more images into PDF output using iLovePDF's documented defaults and immediately return the generated PDF or ZIP as an offloaded download. Images retain their supplied order. This operation consumes processing allowance and cleans up the provider task by default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | Yes | Images to place into PDF output, in order. At least one image is required. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction: eu, us, fr, de, pl, in, or sg. |
| `keep_task` | boolean | No | Keep the provider task after the output is safely offloaded. |
| `merge_after` | boolean | No | Combine all converted images into one PDF when true. |
| `output_filename` | string | No | Optional output PDF filename supported by iLovePDF. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert PDF to Images

**Slug:** `I_LOVE_PDF_CONVERT_PDF_TO_IMAGES`

Convert a PDF using iLovePDF's default PDF-to-JPG behavior and immediately return the generated image or ZIP as an offloaded download. This operation consumes processing credits and cleans up the provider task by default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | PDF file to convert to image output. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction: eu, us, fr, de, pl, in, or sg. |
| `keep_task` | boolean | No | Keep the provider task after the output is safely offloaded. |
| `packaged_filename` | string | No | Optional ZIP filename for output containing multiple images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Task

**Slug:** `I_LOVE_PDF_DELETE_TASK`

Immediately delete an iLovePDF task and its related uploaded and processed files from the task's assigned worker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | string | Yes | Task ID to delete. |
| `worker_server` | string | Yes | Assigned iLovePDF worker hostname for the task. Supply only the hostname, without a scheme, port, or path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Info

**Slug:** `I_LOVE_PDF_GET_ACCOUNT_INFO`

Return the connected iLovePDF project's account type and remaining processing allowance. Use this read-only action before processing files to check capacity.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task Status

**Slug:** `I_LOVE_PDF_GET_TASK_STATUS`

Inspect an iLovePDF task's current state and output metadata on its assigned worker. Use this for retained, externally created, or asynchronous tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task` | string | Yes | Task ID returned by an iLovePDF processing action. |
| `worker_server` | string | Yes | Assigned iLovePDF worker hostname returned with the task. Provide only the hostname, without a scheme, port, or path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge PDFs

**Slug:** `I_LOVE_PDF_MERGE_PDFS`

Merge two or more PDFs in the supplied order and return the merged file in one workflow. This operation consumes processing allowance and creates a temporary provider task, which is deleted after offload unless keep_task is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | Yes | PDF files to merge, in output order. At least two files are required. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction; omit for automatic routing. |
| `keep_task` | boolean | No | Keep the provider task after the result is safely offloaded. |
| `output_filename` | string | No | Optional filename for the merged PDF. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Split PDF

**Slug:** `I_LOVE_PDF_SPLIT_PDF`

Split one PDF by explicit ranges, fixed page intervals, or removed pages and return the resulting PDF or ZIP. The action creates a task, uploads and processes the file, immediately offloads the result, and cleans up by default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | PDF file to split. |
| `ranges` | string | No | Page ranges for ranges mode, such as 1,5,10-14. |
| `region` | string ("eu" | "us" | "fr" | "de" | "pl" | "in" | "sg") | No | Optional processing jurisdiction; omit for automatic routing. |
| `keep_task` | boolean | No | Keep the provider task after the downloaded result is safely offloaded. |
| `split_mode` | string ("ranges" | "fixed_range" | "remove_pages") | Yes | Split strategy: ranges for explicit page ranges, fixed_range for equal page intervals, or remove_pages to omit selected pages. |
| `fixed_range` | integer | No | Number of pages per output PDF when split_mode is fixed_range. |
| `merge_after` | boolean | No | Merge the selected ranges into one PDF. Valid only for ranges mode. |
| `remove_pages` | string | No | Pages to remove in remove_pages mode, such as 1,4,8-12,16. |
| `packaged_filename` | string | No | Optional ZIP filename when splitting produces multiple files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |