iLoveAPI REST API

https://www.iloveapi.com/docs/
Admin
iLoveAPI provides a REST API platform with a comprehensive suite of tools for processing PDF...
Tokens:66,672
Snippets:688
Trust Score:7.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Task Response

Source: https://www.iloveapi.com/docs/api-reference

Example JSON response received after initiating a task.

```json
{
    "server": "api11.ilovepdf.com",
    "task": "g27d4mrsg3ztmnzAgm5d...",
    "remaining_credits": 1234
}
```

--------------------------------

### Start HTML to PDF Task

Source: https://www.iloveapi.com/docs/pdf-guides/html-pdf-api

Starts the execution of the created task.

```javascript
task.start()
```

--------------------------------

### Initialize Signature Management

Source: https://www.iloveapi.com/docs/signature-guides/manage-example

Setup the signature management client using public and private keys.

```ruby
require "bundler/setup"
```

```ruby
require 'ilovepdf'
```

```ruby
signature_management = Ilovepdf::Signature::Management.new(pub_key, priv_key)
```

--------------------------------

### Advanced Signature Request Configuration

Source: https://www.iloveapi.com/docs/signature-guides/advanced-example

This example shows the full setup for a signature task, including setting email parameters, branding, document elements, and multiple receiver types.

```php
use Ilovepdf\SignTask; use Ilovepdf\Sign\Elements\ElementSignature; use Ilovepdf\Sign\Elements\ElementDate; use Ilovepdf\Sign\Elements\ElementInitials; use Ilovepdf\Sign\Elements\ElementInput; use Ilovepdf\Sign\Elements\ElementName; use Ilovepdf\Sign\Elements\ElementText; use Ilovepdf\Sign\Receivers\Signer; use Ilovepdf\Sign\Receivers\Validator; use Ilovepdf\Sign\Receivers\Witness; $signTask = new SignTask("public_key", "secret_key"); // Set the Signature settings $emailSubject = "My subject"; $emailBody = "Body of the first message"; $reminderDays = 3; $daysUntilSignatureExpires = 130; $taskLanguage = "en-US"; $signTask = $signTask-> setVerifySignatureVerification(true)-> setSubject($emailSubject)-> setMessage($emailBody)-> setReminders($reminderDays)-> setLockOrder(false)-> setExpirationDays($daysUntilSignatureExpires)-> setLanguage($taskLanguage)-> setUuidVisible(true); // We first upload the files that we are going to use $file = $signTask->addFile('/path/to/file/document.pdf'); // Set brand $signTask->setBrand('My brand name', '/path/to/file/brand_logo.png'); ////////////// // ELEMENTS // ////////////// // Let's define the elements to be placed in the documents $elements = []; $signatureElement = new ElementSignature(); $signatureElement->setPosition(20, -20) ->setPages("1,2"); //we can define the pages with a comma $dateElement = new ElementDate(); $dateElement->setPosition(30, -30) ->setPages("1-2"); // ranges can also be defined this way $initialsElement = new ElementInitials(); $initialsElement->setPosition(40, -40) ->setPages("1,2,3-6"); // You can define multiple ranges $inputElement = new ElementInput(); $inputElement->setPosition(50, -50) ->setLabel("Passport Number") ->setText("Please put your passport number") ->setPages("1"); $nameElement = new ElementName(); $nameElement->setPosition(60, -60) ->setSize(40) ->setPages("1"); $textElement = new ElementText(); $textElement->setPosition(70, -70) ->setText("This is a text field") ->setSize(40) ->setPages("1"); // Add Elements $elements[]= $signatureElement; $elements[]= $dateElement; $elements[]= $initialsElement; $elements[]= $inputElement; $elements[]= $nameElement; $elements[]= $textElement; /////////////// // RECEIVERS // /////////////// // Create the receivers $signer = new Signer("Signer","signer@email.com"); $validator = new Validator("Validator","validator@email.com"); $witness = new Witness("Witness","witness@email.com"); // Add elements to the receivers that need it $signer->addElements($file, $elements); // Add all receivers to the Sign task $signTask->addReceiver($validator); $signTask->addReceiver($signer); $signTask->addReceiver($witness); // Lastly send the signature request $signature = $signTask->execute()->result;
```

--------------------------------

### Full compression workflow

Source: https://www.iloveapi.com/docs/image-guides/common

Complete example demonstrating authentication, task creation, file addition, execution, and download.

```PHP
// Authenticate
$iloveimg = new Iloveimg('project_public_id', 'project_secret_key');

// Choose your processing tool and create a new task
$myTaskCompress = $iloveimg->newTask('compress');

// Add files to task for upload
$file1 = $myTaskCompress->addFile('path/to/file1_name.jpg');
$file2 = $myTaskCompress->addFile('path/to/file2_name.png');
$file3 = $myTaskCompress->addFile('path/to/file3_name.gif');

// Execute the task
$myTaskCompress->execute();

// Download the packaged files
$myTaskCompress->download();
```

--------------------------------

### Start a Compress Task in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/common

Initialize the API client and create a new compression task using the PHP SDK.

```php
$ilovepdf = new Ilovepdf('project_public_id', 'project_secret_key');
```

```php
$myTaskCompress = $ilovepdf->newTask('compress');
```

```php
// alternately you can also call the task directly if want to save a line.
$myTaskCompress = new CompressTask('project_public_id', 'project_secret_key');
```

--------------------------------

### Start a Compress Task in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/common

Initialize the API client and create a new compression task using the .NET SDK.

```csharp
var api = new LovePdfApi("PUBLIC_KEY", "SECRET_KEY");
```

```csharp
var task = api.CreateTask<CompressTask>();
```

--------------------------------

### Start a Compress Task in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/common

Initialize the API client and create a new compression task using the Ruby SDK.

```ruby
ilovepdf = Ilovepdf::Ilovepdf.new('public_key', 'private_key')
```

```ruby
my_task_compress = ilovepdf.new_task :compress
```

```ruby
# Alternately you can also call the task directly if want to save a line.
my_task_compress = Ilovepdf::Tool::Compress.new('project_public_id', 'project_secret_key');
```

--------------------------------

### Initialize iLovePDF API

Source: https://www.iloveapi.com/docs/signature-guides/manage-example

Setup the API instance using your public and secret keys.

```javascript
import ILovePDFApi from '@ilovepdf/ilovepdf-nodejs';
const instance = new ILovePDFApi(process.env.PUBLIC_KEY!, process.env.SECRET_KEY!);
```

--------------------------------

### Initialize Signature Task and Configuration

Source: https://www.iloveapi.com/docs/signature-guides/advanced-example

Setup the signature task with credentials and configure global settings like branding, language, and email content.

```ruby
require "bundler/setup"
require 'ilovepdf'

pub_key = "YOUR_PUBLIC_KEY"
priv_key = "YOUR_PRIVATE_KEY"

my_task = Ilovepdf::Tool::Signature.new(pub_key, priv_key)
my_task.add_brand(name: "my company name",logo: "/path/to/logo/logo.png")
my_task.language = "es"
my_task.lock_order = false
my_task.email_content(subject: "Subject of the first email", content: "content of the first email")
my_task.expiration_days = 55
my_task.reminders = 2
my_task.verify_enabled = true
my_task.uuid_visible = true
```

--------------------------------

### Basic PDF to JPG conversion in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/pdf-to-jpg-api

Example demonstrating the workflow for converting PDF files to JPG using the .NET SDK.

```csharp
// Create a new task var taskPDFtoJPG = api.CreateTask<PDFtoJPGPTask>(); // Add files to task for upload var file1 = taskPDFtoJPG.AddFile("file1.pdf"); var file2 = taskPDFtoJPG.AddFile("file2.pdf"); // Execute the task taskPDFtoJPG.Process(new PDFtoJPGParams{PdfJpgMode = PdfJpgModes.pages}); // Download the package files taskPDFtoJPG.DownloadFile();
```

--------------------------------

### Start an image processing task in PHP

Source: https://www.iloveapi.com/docs/image-guides/common

Initialize the API client and create a new compression task. Authentication is required once per project.

```PHP
$iloveimg = new Iloveimg('project_public_id', 'project_secret_key');
```

```PHP
$myTaskCompress = $iloveimg->newTask('compress');
```

```PHP
// alternately you can also call the task directly if want to save a line.
$myTaskCompress = new CompressImageTask('project_public_id', 'project_secret_key');
```

--------------------------------

### HTML to PDF Task Execution Steps

Source: https://www.iloveapi.com/docs/pdf-guides/html-pdf-api

Individual steps for starting, configuring, and downloading the converted PDF file.

```javascript
task.start()
```

```javascript
.then(() => {
    return task.addFile('https://ilovepdf.com');
})
```

```javascript
.then(() => {
    return task.process({ single_page: true });
})
```

```javascript
.then(() => {
    return task.download();
})
```

```javascript
.then((data) => {
    fs.writeFileSync('path/to/local/file_name.pdf', data);
});
```

--------------------------------

### Start a Compress Task in Node.js

Source: https://www.iloveapi.com/docs/pdf-guides/common

Initialize the API client and create a new compression task using the Node.js SDK.

```javascript
const ilovepdf = new ILovePDFApi('PUBLIC_KEY');
```

```javascript
const myTaskCompress = ilovepdf.newTask('compress');
```

--------------------------------

### Basic PDF to JPG conversion in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/pdf-to-jpg-api

Example demonstrating the workflow for converting PDF files to JPG using the PHP SDK.

```php
// Create a new task $myTaskConvertPDF = $ilovepdf->newTask('pdfjpg'); // Add files to task for upload $file1 = $myTaskConvertPDF->addFile('path/to/file1_name.pdf'); $file2 = $myTaskConvertPDF->addFile('path/to/file2_name.pdf'); // Execute the task $myTaskConvertPDF->execute(); // Download the package files $myTaskConvertPDF->download();
```

--------------------------------

### GET /v1/start/{tool}/{region}

Source: https://www.iloveapi.com/docs/api-reference

Retrieve the assigned server and Task ID required for subsequent operations.

```APIDOC
## GET /v1/start/{tool}/{region}

### Description
Retrieve the information about which server will be your assigned server and which Task ID to use.

### Method
GET

### Endpoint
https://api.ilovepdf.com/v1/start/{tool}/{region}

### Parameters
#### Path Parameters
- **tool** (string) - Required - The tool to access (e.g., compress, extract, merge).
- **region** (string) - Required - The region/jurisdiction for processing (e.g., eu, us, fr, de, pl, in, sg).

### Response
#### Success Response (200)
- **server** (string) - The assigned server URL.
- **task** (string) - The unique Task ID.
- **remaining_credits** (integer) - Number of credits remaining.

### Response Example
{
  "server": "api11.ilovepdf.com",
  "task": "g27d4mrsg3ztmnzAgm5d...",
  "remaining_credits": 1234
}
```

--------------------------------

### Execute Split Task in Node.js

Source: https://www.iloveapi.com/docs/pdf-guides/split-pdf-api

Demonstrates the promise chain for starting a task, adding a file, processing with page removal, and downloading the result.

```javascript
const task = ilovepdf.newTask('merge') as SplitTask;
task.start()
.then(() => {
    return task.addFile('path/to/file1_name.pdf');
})
.then(() => {
    return task.process({ remove_pages: '2-4, 6-8' });
})
.then(() => {
    return task.download();
})
.then((data) => {
    fs.writeFileSync('path/to/local/file_name.pdf', data);
});
```

--------------------------------

### Initialize and Process HTML to PDF Task

Source: https://www.iloveapi.com/docs/pdf-guides/html-pdf-api

A complete example of creating an HTML to PDF task, adding a URL, processing with A4 page size, and saving the result.

```javascript
const task = ilovepdf.newTask('htmlpdf') as HtmlPdfTask; task.start() .then(() => { return task.addFile('https://ilovepdf.com'); }) .then(() => { return task.process({ page_size: 'A4' }); }) .then(() => { return task.download(); }) .then((data) => { fs.writeFileSync('path/to/local/file_name.pdf', data); });
```

--------------------------------

### Compress PDF Task in Node.js

Source: https://www.iloveapi.com/docs/pdf-guides/compress-pdf-api

Demonstrates the full lifecycle of a compression task including starting, adding files, processing, and downloading the result.

```javascript
const task = ilovepdf.newTask('compress') as CompressTask;
```

```javascript
task.start()
```

```javascript
.then(() => {
 	 	return task.addFile('path/to/file1_name.pdf');
})
```

```javascript
.then(() => {
 	 	return task.process({ compression_level: 'extreme' });
})
```

```javascript
.then(() => {
 	 	return task.download();
})
```

```javascript
.then((data) => {
 	 	fs.writeFileSync('path/to/local/file_name.pdf', data);
});
```

--------------------------------

### Set Starting Page Number in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/page-numbers-pdf-api

Configures the starting page number for the PDF document.

```php
// Create a new task
$myTaskPageNumbers = $ilovepdf->newTask('pagenumber');
// Set your tool options
$myTaskPageNumbers->setStartNumber(2);
// Execute the task
$myTaskPageNumbers->execute();
```

--------------------------------

### Set Starting Page Number in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/page-numbers-pdf-api

Uses the PageNumbersParams object to define the starting number for the task.

```csharp
// Create a new task
var taskPageNumbers = api.CreateTask<PageNumbersTask>();
// Set your tool options
var parameters = new PageNumbersParams (
            {
                StartingNumber   = 2
            };
// Execute the task
taskPageNumbers.Process(parameters);
```

--------------------------------

### Initialize and Configure JPG to PDF Task in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Create an image-to-PDF task and set the orientation to landscape.

```ruby
my_task_convert_jpg = ilovepdf.new_task :imagepdf
```

```ruby
my_task_convert_jpg.orientation = 'landscape'
```

--------------------------------

### GET /v1/signature/receiver/info/{receiver_token_requester}

Source: https://www.iloveapi.com/docs/api-reference

Retrieves detailed information about a specific signature receiver.

```APIDOC
## GET /v1/signature/receiver/info/{receiver_token_requester}

### Description
Retrieves information about a receiver, including their status, type, and contact details.

### Method
GET

### Endpoint
https://api.ilovepdf.com/v1/signature/receiver/info/{receiver_token_requester}

### Parameters
#### Path Parameters
- **receiver_token_requester** (string) - Required - The internal identifier of the receiver.

### Response
#### Success Response (200)
- **uuid** (string) - Public identifier of the signature.
- **name** (string) - Name of the receiver.
- **email** (string) - Email of the receiver.
- **phone** (string) - Phone of the receiver.
- **type** (string) - Type of receiver (signer, validator, or witness).
- **token_requester** (string) - Internal identifier of the receiver.
- **status** (string) - Current status of the receiver (e.g., waiting, sent, viewed, signed).
- **access_code** (boolean) - Indicates if an access code is required.
- **force_signature_type** (string) - Signature adoption method.
- **notes** (string) - Rejection reason if applicable.

### Response Example
{
  "uuid": "FCE3CAB9-2320-44C1-B18B-0F23BE2CF2FD",
  "name": "name",
  "email": "email@email.com",
  "phone": null,
  "type": "signer",
  "token_requester": "tokenrequester",
  "status": "waiting",
  "access_code": false,
  "force_signature_type": "all",
  "notes": null
}
```

--------------------------------

### GET https://api.ilovepdf.com/v1/signature/list

Source: https://www.iloveapi.com/docs/api-reference

List all created signature requests with pagination support.

```APIDOC
## GET https://api.ilovepdf.com/v1/signature/list

### Description
List all created signature requests.

### Method
GET

### Endpoint
https://api.ilovepdf.com/v1/signature/list

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Lookup page (default: 0)
- **per-page** (integer) - Optional - Paginator size, accepted values are in the range [1, 100] (default: 20)

### Response
#### Success Response (200)
- **Array** (object) - List of signature request objects

#### Response Example
[
  {
    "uuid": "18B06FDC-8643-447C-BAFB-9D3F8CA421B6",
    "status": "draft",
    "email": "email@email.com"
  }
]
```

--------------------------------

### Initialize and Configure JPG to PDF Task in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Create an ImageToPDF task and set the orientation to landscape.

```csharp
var taskImageToPDF = api.CreateTask<ImagetoPDFTask>();
```

```csharp
taskImageToPDF.Process(new ImageToPdfParams{Orientation  = Orientations.landscape});
```

--------------------------------

### GET /v1/task

Source: https://www.iloveapi.com/docs/api-reference

Retrieves a list of processed tasks with optional filtering and pagination.

```APIDOC
## GET /v1/task

### Description
List and filter all tasks. Note: This endpoint requires a secret_key and is intended for server-side use.

### Method
GET

### Endpoint
https://api.ilovepdf.com/v1/task

### Parameters
#### Query Parameters
- **secret_key** (string) - Required - Your project secret key.
- **page** (integer) - Optional - Results are offered paginated in 50 results per page.
- **tool** (string) - Optional - Filter tasks by tool.
- **status** (string) - Optional - Filter tasks by task status type.
- **custom_int** (integer) - Optional - Filter tasks by custom_int.
```

--------------------------------

### Get Receiver Information

Source: https://www.iloveapi.com/docs/signature-guides/manage-example

Retrieve details about a specific receiver using their token.

```javascript
// Get information about a specific receiver.
instance.getReceiverInfo('<RECEIVER_TOKEN_REQUESTER>')
.then(receiverInfo => {
    console.log('Information related to a specific receiver.');
    console.log(receiverInfo);
});
```

--------------------------------

### Get Signature Status

Source: https://www.iloveapi.com/docs/signature-guides/manage-example

Retrieve the current status of a specific signature request.

```javascript
// Get the current status of the signature.
instance.getSignatureStatus('<SIGNATURE_TOKEN_REQUESTER>')
.then(status => {
    console.log('Signature status.');
    console.log(status);
});
```

--------------------------------

### Basic PDF Compression in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/compress-pdf-api

Demonstrates the workflow for compressing PDF files using the .NET SDK.

```C#
// Create a new task var taskCompress = api.CreateTask<CompressTask>(); // Add files to task for upload var file1 = taskCompress.AddFile("file1.pdf"); var file2 = taskCompress.AddFile("file2.pdf"); // Execute the task taskCompress.Process(); // Download the package files taskCompress.DownloadFile();
```

--------------------------------

### Signature Request JSON Structure

Source: https://www.iloveapi.com/docs/api-reference

Example of the JSON object representing a signature request.

```json
{
    "completed_on": null,
    "created": "2021-10-18 14:03:43",
    "email": "email@email.com",
    "expires": "2022-02-15 15:00:00",
    "language": "en",
    "mode": "multiple",
    "name": "name",
    "notes": null,
    "signer_reminder_days_cycle": 2,
    "subject_signer": null,
    "message_signer": null,
    "token_requester": "token-requester",
    "uuid": "18B06FDC-8643-447C-BAFB-9D3F8CA421B6",
    "expiring": false,
    "expired": false,
    "files": [
        {
            "filename": "sample.pdf",
            "pages": 2,
            "filesize": 22698
        }
    ],
    "signers": [
        {
            "uuid": "FCE3CAB9-2320-44C1-B18B-0F23BE2CF2FD",
            "name": "name",
            "email": "email@email.com",
            "phone": null,
            "type": "signer",
            "token_requester": "token-signer-requester",
            "status": "waiting",
            "access_code": false,
            "phone_access_code": false,
            "force_signature_type": "all",
            "notes": null
        }
    ],
    "status": "draft",
    "certified": true,
    "verify_enabled": true,
    "lock_order": false,
    "signer_reminders": true,
    "about_to_expire_reminder": true,
    "uuid_visible": true
}
```

--------------------------------

### Basic Office to PDF conversion in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/office-to-pdf-api

Demonstrates the workflow for converting Office files to PDF using the Ruby library.

```Ruby
# Create a new task my_task_convert_office = ilovepdf.new_task :officepdf # Add files to task for upload file1 = my_task_convert_office.add_file = 'path/to/file1_name.doc' file2 = my_task_convert_office.add_file = 'path/to/file2_name.xls' # Execute the task my_task_convert_office.execute # Download the package files my_task_convert_office.download
```

--------------------------------

### Initialize and configure Image to PDF task in C#

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Create an ImageToPDF task and set the page size to A4.

```csharp
var taskImageToPDF = api.CreateTask<ImagetoPDFTask>();
```

```csharp
taskImageToPDF.Process(new ImageToPdfParams(PageSize = PageSizes.A4);
```

--------------------------------

### GET /v1/signature/{token_requester}/download-audit

Source: https://www.iloveapi.com/docs/api-reference

Downloads the audit PDF file for a completed signature request.

```APIDOC
## GET /v1/signature/{token_requester}/download-audit

### Description
Downloads the audit PDF file. The signature request status must be 'completed'.

### Method
GET

### Endpoint
https://{server}/v1/signature/{token_requester}/download-audit

### Parameters
#### Path Parameters
- **token_requester** (string) - Required - The token requester identifier.

### Notes
Call https://api.ilovepdf.com/v1/start/sign to retrieve the {server} parameter required for this call.
```

--------------------------------

### List Signature Requests Response

Source: https://www.iloveapi.com/docs/api-reference

Example response body returned when listing signature requests.

```json
[
    {
        "completed_on": null,
        "created": "2021-10-18 14:03:43",
        "email": "email@email.com",
        "expires": "2022-02-15 15:00:00",
        "language": "en",
        "mode": "multiple",
        "name": "name",
        "notes": null,
        "signer_reminder_days_cycle": 2,
        "subject_cc": null,
        "subject_signer": null,
        "token_requester": "token-requester",
        "uuid": "18B06FDC-8643-447C-BAFB-9D3F8CA421B6",
        "expiring": false,
        "expired": false,
        "files": [
            {
                "filename": "sample.pdf",
                "pages": 2,
                "filesize": 22698
            }
        ],
        "signers": [
            {
                "uuid": "FCE3CAB9-2320-44C1-B18B-0F23BE2CF2FD",
                "name": "name",
                "email": "email@email.com",
                "phone": null,
                "type": "signer",
                "token_requester": "token-signer-requester",
                "status": "waiting",
                "access_code": false,
                "phone_access_code": false,
                "force_signature_type": "all",
                "notes": null
            }
        ],
        "status": "draft",
        "certified": true,
        "verify_enabled": true,
        "lock_order": false,
        "signer_reminders": true,
        "about_to_expire_reminder": true,
        "uuid_visible": true
    }
]
```

--------------------------------

### Basic Office to PDF conversion in .Net

Source: https://www.iloveapi.com/docs/pdf-guides/office-to-pdf-api

Demonstrates the workflow for converting Office files to PDF using the .Net library.

```C#
// Create a new task var taskConvertOffice = api.CreateTask<OfficeToPdfTask>(); // Add files to task for upload var file1 = taskConvertOffice.AddFile("path/to/file/file1_name.docx"); var file2 = taskConvertOffice.AddFile('path/to/file1_name.xls'); // Execute the task taskConvertOffice.Process(); // Download the package files taskConvertOffice.DownloadFile();
```

--------------------------------

### API Response Structure

Source: https://www.iloveapi.com/docs/api-reference

Example of a successful API response object indicating task completion.

```json
{ "download_filename": "output.zip", "filesize": 0, "output_filesize": 0, "output_filenumber": 2, "output_extensions": "[\"pdf\"]", "timer": "0.028", "status": "TaskSuccess" }
```

```json
{
 		"download_filename": "output.zip",
 		"filesize": 0,
 		"output_filesize": 0,
 		"output_filenumber": 2,
 		"output_extensions": "[\"pdf\"]",
 		"timer": "0.028",
 		"status": "TaskSuccess"
}
```

--------------------------------

### Set watermark opacity in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/watermark-pdf-api

Example of configuring watermark parameters using the WatermarkParams class.

```csharp
// Select watermark parameters
var parameters = new WatermarkParams(
                new WatermarkModeText("watermark text"))
            {
                Transparency = 50
            };
// Execute the task
taskWatermark.Process(parameters);
```

--------------------------------

### Basic PDF Summarization in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/summarize-api

Demonstrates the standard workflow for creating a task, adding a file, executing the process, and downloading the result.

```PHP
// Create a new task $myTaskSummarize = $ilovepdf->newTask('summarize'); // Add files to task for upload $file1 = $myTaskSummarize->addFile('path/to/file1_name.pdf'); // Execute the task $myTaskSummarize->execute(); // Download the summarized file $myTaskSummarize->download();
```

--------------------------------

### Basic Image Compression in PHP

Source: https://www.iloveapi.com/docs/image-guides/compress

Demonstrates the standard workflow for compressing images by creating a task, adding files, executing the process, and downloading the result.

```PHP
// Create a new task
$myTaskCompress = $iloveimg->newTask('compress');

// Add files to task for upload
$file1 = $myTaskCompress->addFile('path/to/file1_name.jpg');
$file2 = $myTaskCompress->addFile('path/to/file2_name.png');

// Execute the task
$myTaskCompress->execute();

// Download the package files
$myTaskCompress->download();
```

--------------------------------

### Add Page Numbers in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/page-numbers-pdf-api

Initializes a page number task and sets the starting page number.

```ruby
my_task_page_numbers = ilovepdf.new_task :pagenumber
my_task_page_numbers.start_number = 2
my_task_page_numbers.execute
```

--------------------------------

### Basic Image to PDF Conversion in .NET

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Demonstrates the workflow for converting images to PDF using the .NET SDK.

```C#
// Create a new task var taskImageToPDF = api.CreateTask<ImagetoPDFTask>(); // Add files to task for upload var file1 = taskImageToPDF.AddFile("file1.pdf"); var file2 = taskImageToPDF.AddFile("file2.pdf"); // Execute the task taskImageToPDF.Process(); // Download the package files taskImageToPDF.DownloadFile();
```

```C#
// Create a new task
```

```C#
var taskImageToPDF = api.CreateTask<ImagetoPDFTask>();
```

```C#
// Add files to task for upload
```

```C#
var file1 = taskImageToPDF.AddFile("file1.pdf");
```

```C#
var file2 = taskImageToPDF.AddFile("file2.pdf");
```

```C#
// Execute the task
```

```C#
taskImageToPDF.Process();
```

```C#
// Download the package files
```

```C#
taskImageToPDF.DownloadFile();
```

--------------------------------

### Validate PDF/A with Node.js

Source: https://www.iloveapi.com/docs/pdf-guides/validate-pdfa

Use the promise-based API to start a validation task and retrieve the status from the response.

```JavaScript
const task = ilovepdf.newTask('validatepdfa') as ValidatePdfaTask; task.start() .then(() => { return task.addFile('path/to/file1_name.pdf'); }) .then(() => { return task.process({ conformance: 'pdfa-2b' }); }) .then(() => { const status = task.responses.process?.validations![0].status; });
```

--------------------------------

### GET https://api.ilovepdf.com/v1/signature/requesterview/{token_requester}

Source: https://www.iloveapi.com/docs/api-reference

Retrieve the status of a specific signature request using its requester token.

```APIDOC
## GET https://api.ilovepdf.com/v1/signature/requesterview/{token_requester}

### Description
Get Signature status for a specific request.

### Method
GET

### Endpoint
https://api.ilovepdf.com/v1/signature/requesterview/{token_requester}

### Parameters
#### Path Parameters
- **token_requester** (string) - Required - The unique requester token for the signature request.
```

--------------------------------

### Basic Image Crop in PHP

Source: https://www.iloveapi.com/docs/image-guides/crop

Demonstrates the process of creating a crop task, setting dimensions and origin coordinates, executing the task, and downloading the result.

```PHP
// Create a new task
$myTask = $iloveimg->newTask('crop');

// Add files to task for upload
$file = $myTask->addFile('path/to/file_name.jpg');

//crop a square of 25x50px starting on 10px from top and 10px from left

// Set your crop origin coordinates
$myTask->setX(10);
$myTask->->setY(10);

// Set the size to crop
$myTask->setWidth(25);
$myTask->setHeight(50);

// Execute the task
$myTask->execute();

// Download the cropped file
$myTask->download();
```

--------------------------------

### Initializing the API

Source: https://www.iloveapi.com/docs/signature-guides/basic-example

Instantiate the API client using public and secret keys from environment variables.

```javascript
const api = new ILovePDFApi(process.env.PUBLIC_KEY!, process.env.SECRET_KEY!);
```

--------------------------------

### Signature request response structure

Source: https://www.iloveapi.com/docs/api-reference

Example of the JSON response object returned after creating a signature request.

```json
{ "about_to_expire_reminder": false, "completed_on": null, "created": "2021-10-18 14:03:43", "disable_notifications": null, "email": "email@email.com", "expires": "2022-02-15 15:00:00", "language": "en", "lock_order": false, "mode": "multiple", "name": "Guillem", "notes": null, "signer_reminder_days_cycle": 2, "signer_reminders": true, "subject_cc": null, "subject_signer": null, "timezone": null, "token_requester": "15928374asdf", "uuid": "18B06FDC-8643-447C-BAFB-9D3F8CA421B6", "uuid_visible": true, "verify_enabled": true, "expired": false, "expiring": false, "signers": [ { "uuid": "FCE3CAB9-2320-44C1-B18B-0F23BE2CF2FD", "name": "name", "email": "emailsigner@email.com", "phone": null, "type": "signer", "token_requester": "1234asdf", "status": "waiting", "access_code": false, "phone_access_code": false, "force_signature_type": "all", "notes": null } ], "files": [ { "filename": "sample.pdf", "pages": 2, "filesize": 22698 } ], "certified": true, "status": "draft" }
```

--------------------------------

### Basic Office to PDF conversion in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/office-to-pdf-api

Demonstrates the workflow for converting Office files to PDF using the PHP library.

```PHP
// Create a new task $myTaskConvertOffice = $ilovepdf->newTask('officepdf'); // Add files to task for upload $file1 = $myTaskConvertOffice->addFile('path/to/file1_name.doc'); $file2 = $myTaskConvertOffice->addFile('path/to/file2_name.xls'); // Execute the task $myTaskConvertOffice>execute(); // Download the package files $myTaskConvertOffice->download();
```

--------------------------------

### Upload File Response

Source: https://www.iloveapi.com/docs/api-reference

Example JSON response containing the server filename after a successful file upload.

```json
{
    "server_filename": "cd29201ebe...5257c95d9843.pdf"
}
```

--------------------------------

### Initialize JPG to PDF task in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Initializes a new image-to-PDF task and sets the margin configuration.

```ruby
# Choose your processing tool
my_task_convert_jpg = ilovepdf.new_task :imagepdf
```

```ruby
# Set your tool options
my_task_convert_jpg.margin = 20
```

--------------------------------

### Set Watermark Parameters in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/watermark-pdf-api

Example of setting text and horizontal position for a watermark task in PHP.

```php
// Select watermark parameters $myTaskWatermark->setText('iLovePDF'); $myTaskWatermark->setHorizontalPosition('left'); // Execute the task $myTaskPageNumbers->execute();
```

--------------------------------

### Split PDF with Smart Split in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/smart-split-pdf-api

Demonstrates the full workflow for initializing a Smart Split task, setting a custom prompt, executing the task, and downloading the results.

```PHP
require_once __DIR__ . '/vendor/autoload.php'; use Ilovepdf",
```

```PHP
require_once __DIR__ . '/vendor/autoload.php';
```

```PHP
use Ilovepdf\Ilovepdf;
```

```PHP
$ilovepdf = new Ilovepdf('PUBLIC_KEY', 'SECRET_KEY');
```

```PHP
$task = $ilovepdf->newTask('splitsmart');
```

```PHP
$task->addFile('path/to/file.pdf');
```

```PHP
$task->setPrompt('Split this PDF by invoice number.');
```

```PHP
$task->execute();
```

```PHP
$task->download(__DIR__);
```

--------------------------------

### Watermark PDF Task Workflow

Source: https://www.iloveapi.com/docs/pdf-guides/watermark-pdf-api

Full workflow for creating, starting, processing, and downloading a watermarked PDF file.

```javascript
const task = ilovepdf.newTask('watermark') as WatermarkTask;
task.start()
.then(() => {
    return task.addFile('path/to/file1_name.pdf');
})
.then(() => {
    return task.process({ text: 'myWatermarkText', horizontal_position: 'left' });
})
.then(() => {
    return task.download();
})
.then((data) => {
    fs.writeFileSync('path/to/local/file_name.pdf', data);
});
```

--------------------------------

### Add a basic watermark with PHP

Source: https://www.iloveapi.com/docs/image-guides/watermark

Initializes a conversion task, adds a file, sets the output format, and executes the download process.

```PHP
// Create a new task
$myTaskConvert = $iloveimg->newTask('convert');

// Add files to task for upload
$file1 = $myTaskConvert->addFile('path/to/file1_name.jpg');

$myTaskConvert->setTo('gif');

// Execute the task
$myTaskConvert->execute();

// Download the package files
$myTaskConvert->download();
```

--------------------------------

### Signature response example

Source: https://www.iloveapi.com/docs/api-reference

A JSON object representing a signature event, including signature details and signer information.

```json
{ "event": "signature.signer.completed", "data": { "signature": { "expired": false, "lock_order": false, "expiring": false, "notes": null, "brand_name": null, "language": null, "subject_cc": null, "message_signer": null, "subject_signer": null, "token_requester": "xxxxxxxxxxxxx", "created": "2024-06-17 12:02:59", "completed_on": "2024-06-17 12:39:34", "expires": "2024-10-25 13:00:00", "status": "completed", "name": "test", "email": "test@isfjdijasdifjdasfadsf.com", "uuid_visible": true, "certified": true, "signer_reminders": true, "signer_reminder_days_cycle": 2, "verify_enabled": true, "uuid": "9B41A389-6645-45FB-A72D-3A19CC3EF9F9", "mode": "multiple", "files": [ { "filename": "a.pdf", "pages": 62, "filesize": 2617649 } ] }, "signer": { "uuid": "5E4E6228-CF1E-4533-BC85-4FA660117EF5", "name": "asdfadsfafas", "email": "test2@8usijfas9yudsfsdf.com", "phone": null, "phone_retries_left": 1, "type": "signer", "token_requester": "xxxxxxxxxxxxxxxxxxx", "status": "signed", "access_code": false, "force_signature_type": "all", "notes": null, "fix_email_needed": false, "fix_phone_needed": false } } }
```

```text
xxxxxxxxxx
```

```json
                 {
  "event": "signature.signer.completed",
  "data": {
    "signature": {
      "expired": false,
      "lock_order": false,
      "expiring": false,
      "notes": null,
      "brand_name": null,
      "language": null,
      "subject_cc": null,
      "message_signer": null,
      "subject_signer": null,
      "token_requester": "xxxxxxxxxxxxx",
      "created": "2024-06-17 12:02:59",
      "completed_on": "2024-06-17 12:39:34",
      "expires": "2024-10-25 13:00:00",
      "status": "completed",
      "name": "test",
      "email": "test@isfjdijasdifjdasfadsf.com",
      "uuid_visible": true,
      "certified": true,
      "signer_reminders": true,
      "signer_reminder_days_cycle": 2,
      "verify_enabled": true,
      "uuid": "9B41A389-6645-45FB-A72D-3A19CC3EF9F9",
      "mode": "multiple",
      "files": [
        {
          "filename": "a.pdf",
          "pages": 62,
          "filesize": 2617649
        }
      ]
    },
    "signer": {
      "uuid": "5E4E6228-CF1E-4533-BC85-4FA660117EF5",
      "name": "asdfadsfafas",
      "email": "test2@8usijfas9yudsfsdf.com",
      "phone": null,
      "phone_retries_left": 1,
      "type": "signer",
      "token_requester": "xxxxxxxxxxxxxxxxxxx",
      "status": "signed",
      "access_code": false,
      "force_signature_type": "all",
      "notes": null,
      "fix_email_needed": false,
      "fix_phone_needed": false
    }
  }
}
```

--------------------------------

### Basic JPG to PDF conversion in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/jpg-to-pdf-api

Initializes an image-to-PDF task, adds files, executes the process, and downloads the result.

```ruby
my_task_convert_jpg = ilovepdf.new_task :imagepdf
# Add files to task for upload
file1 = my_task_convert_jpg.add_file 'path/to/image1_name.jpg'
file2 = my_task_convert_jpg.add_file 'path/to/image2_name.pdf'
# Execute the task
my_task_convert_jpg.execute
# Download the package files
my_task_convert_jpg.download
```

--------------------------------

### Task Webhook Response Example

Source: https://www.iloveapi.com/docs/api-reference

The JSON structure for task.completed and task.failed events, providing details about the processed task.

```json
{ "event": "task.completed", "data": { "task": { "tool": "compress", "process_start": "2024-06-17 10:18:17", "custom_int": null, "custom_string": null, "status": "TaskSuccess", "status_message": "This task has been processed successfully.", "timer": "0.206", "filesize": 13264, "output_filesize": 9792, "output_filenumber": 1, "output_extensions": [ "pdf" ], "server": "api70.ilovepdf.com", "task": "xxxxxxxxxxxxxxxxxxxxxxxxx", "file_number": "1", "download_filename": "server.pdf" } } }
```

```json
xxxxxxxxxx
```

```json
{
  "event": "task.completed",
  "data": {
    "task": {
      "tool": "compress",
      "process_start": "2024-06-17 10:18:17",
      "custom_int": null,
      "custom_string": null,
      "status": "TaskSuccess",
      "status_message": "This task has been processed successfully.",
      "timer": "0.206",
      "filesize": 13264,
      "output_filesize": 9792,
      "output_filenumber": 1,
      "output_extensions": [
        "pdf"
      ],
      "server": "api70.ilovepdf.com",
      "task": "xxxxxxxxxxxxxxxxxxxxxxxxx",
      "file_number": "1",
      "download_filename": "server.pdf"
    }
  }
}
```

--------------------------------

### Compress PDF with Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/compress-pdf-api

Demonstrates the basic workflow for creating a compression task, adding files, executing, and downloading the result in Ruby.

```ruby
my_task_split = ilovepdf.new_task :compress
# Add files to task for upload
file1 = my_task_compress.add_file('path/to/file1_name.pdf')
file2 = my_task_compress.add_file('path/to/file2_name.pdf')
# Execute the task
my_task_compress.execute
# Download the package files
my_task_compress.download
```

--------------------------------

### POST /v1/signature

Source: https://www.iloveapi.com/docs/api-reference

Creates a new signature request. Requires a task ID from the start API and previously uploaded files.

```APIDOC
## POST /v1/signature

### Description
This endpoint is used to create a signature request. Before calling this, you must call the Start API (https://api.ilovepdf.com/v1/start/sign) and upload the necessary files.

### Method
POST

### Endpoint
https://{server}/v1/signature

### Parameters
#### Request Body
- **task** (string) - Required - The task ID obtained from the start API call.
- **files** (array) - Required - Files to be signed. Maximum 5 files. Each file object contains: server_filename (string), filename (string), brand_name (string, optional), brand_logo (string, optional).
- **signers** (array) - Required - Receivers participating in the signature process. Maximum 50 signers. Each signer object contains: name (string), email (string), phone (string, optional), files (array of objects with server_filename and elements).

### Elements
Each element in the files array has the following attributes:
- **position** (string) - Required - Element position using Gravity or Standard positioning.
- **horizontal_position_adjustment** (integer) - Optional - Pushes element right (Gravity only).
- **vertical_position_adjustment** (integer) - Optional - Pushes element top (Gravity only).
- **pages** (string) - Required - Page or pages where the element is placed.
- **content** (string) - Required for date/text types - Specifies text content or date format.
```

--------------------------------

### Initialize PDF to JPG Task in Ruby

Source: https://www.iloveapi.com/docs/pdf-guides/pdf-to-jpg-api

Sets up a new PDF to JPG task and configures the extraction mode.

```ruby
# Choose your processing tool
my_task_convert_pdf = ilovepdf.new_task :pdfjpg
```

```ruby
# Set your tool options
my_task_convert_pdf.mode = 'extract'
```

--------------------------------

### Basic Edit PDF Implementation

Source: https://www.iloveapi.com/docs/pdf-guides/edit-api

Demonstrates the fundamental steps to initialize an edit task, add a file, define a text element, and execute the process.

```php
// Create a new task
$editpdfTask = $ilovepdf->newTask('editpdf');
```

```php
// Add files to task for upload
$pdfFile = $editpdfTask->addFile('path/to/file1_name.pdf');
```

```php
// Create an element
$textElem = new TextElement();
```

```php
// Set your element options
$textElem->setText("Sample text");
```

```php
// Add text element to task
$editpdfTask->addElement($textElem);
```

```php
// Execute the task
$myTaskSplit->execute();
```

```php
// Download the package files
$myTaskSplit->download();
```

--------------------------------

### Basic PDF Compression in PHP

Source: https://www.iloveapi.com/docs/pdf-guides/compress-pdf-api

Demonstrates the workflow for compressing PDF files using the PHP SDK.

```PHP
// Create a new task $myTaskCompress = $ilovepdf->newTask('compress'); // Add files to task for upload $file1 = $myTaskCompress->addFile('path/to/file1_name.pdf'); $file2 = $myTaskCompress->addFile('path/to/file2_name.pdf'); // Execute the task $myTaskCompress->execute(); // Download the package files $myTaskCompress->download();
```
Tokens:
Raw