PDF Operation APIs

pdf/a tasks

Job Builder

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

This operation is experimental and currently in preview. Please contact us if you have feedback or experience issues.

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/a

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/a" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
  "input": [
    "73df1e16-fd8b-47a1-a156-f197babde91a"
  ],
  "conformance_level": "3b"
}'

pdf/ocr tasks

Job Builder

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

This operation is experimental and currently in preview. Please contact us if you have feedback or experience issues.

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/ocr

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/ocr" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ],
    "auto_orient": true,
    "language": "eng,deu"
}'

pdf/encrypt tasks

Job Builder

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

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/encrypt

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/encrypt" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ],
    "set_password": "123",
    "set_owner_password": "456",
    "allow_extract": false,
    "allow_accessibility": true,
    "allow_modify": "form",
    "allow_print": "full"
}'

pdf/decrypt tasks

Job Builder

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

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/decrypt

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/decrypt" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ],
    "password": "123"
}'

pdf/split-pages tasks

Job Builder

Split a PDF into one PDF file per page.

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/split-pages

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/split-pages" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ]
}'

pdf/extract-pages tasks

Job Builder

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

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/extract-pages

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/extract-pages" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ],
    "pages": "1,2"
}'

pdf/rotate-pages tasks

Job Builder

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

Arguments
input string or array, required The ID of the input tasks. Multiple task IDs can be provided as an array.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .
filename string, optional Choose a filename (including extension) for the output file.
engine string, optional Use a specific engine for the conversion.

engine_version string, optional Use a specific engine version for the conversion.
timeout integer, optional Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/pdf/rotate-pages

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/pdf/rotate-pages" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
    "input": [
        "73df1e16-fd8b-47a1-a156-f197babde91a"
    ],
    "pages": "1,2",
    "rotation": "+90"
}'