Operations

PDF Operations

Convert, optimize and manipulate PDF files

Convert to PDF/A

Convert a PDF file to PDF/A-1B, PDF/A-2B or PDF/A-3B. Optionally add a ZUGFeRD invoice XML file.

Task Parameters

operation

string required

Value is pdf/a.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/a jobs.

PDF OCR

Adds an OCR text layer to scanned PDF files, allowing them to be searched or copy-pasted.

Task Parameters

operation

string required

Value is pdf/ocr.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/ocr jobs.

Encrypt PDF

Encrypt a PDF file and optionally set a password. This operation also supports PDF security restrictions.

Task Parameters

operation

string required

Value is pdf/encrypt.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/encrypt jobs.

Decrypt PDF

Decrypt a PDF file and remove a password. The password of he PDF file is required to decrypt it.

Task Parameters

operation

string required

Value is pdf/decrypt.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/decrypt jobs.

Split PDF Pages

Split a PDF into one PDF file per page.

Task Parameters

operation

string required

Value is pdf/split-pages.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/split-pages jobs.

Exctract PDF Pages

Extract single pages or page ranges from a PDF file into a new PDF file.

Task Parameters

operation

string required

Value is pdf/extract-pages.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/extract-pages jobs.

Rotate PDF Pages

Rotate single pages or all pages of a PDF file by a given angle.

Task Parameters

operation

string required

Value is pdf/rotate-pages.

input

string or array of task names required

Files to perform the operation on

engine

string

Use a specific engine for the conversion.

engine_version

string

Use a specific engine version for the conversion.

filename

string

Choose a filename (including extension) for the output file.

timeout

integer

Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Example Job

Using the parameters from above, you can create a job:

POSThttps://api.cloudconvert.com/v2/jobs

Use the Job Builder to generate and try out pdf/rotate-pages jobs.

Merge Files

Combine multiple input files in one single PDF

Create Archives

Create a task to create a ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.