Operations

Create Archives

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

To create an archive, create a job with a archive task.

Task Parameters

operation

string required

Value is archive.

input

string or array of task names required

The input task name(s) for this task.

output_format

string required

The archive format.

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
{
    "tasks": {
        "import-frist-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/zombies.pdf"
        },
        "import-second-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/logo.png"
        },
        "archive-my-files": {
            "operation": "archive",
            "input": [
                "import-frist-file",
                "import-second-file"
            ],
            "output_format": "zip"
        },
        "export-my-file": {
            "operation": "export/url",
            "input": "archive-my-files"
        }
    }
}

# Install the CloudConvert CLI: npm install -g cloudconvert-cli
# The CloudConvert CLI does not support these task types: archive.

$ curl -X POST "https://api.cloudconvert.com/v2/jobs" \
    -H "Authorization: Bearer API_KEY" \
    -H "Content-type: application/json" \
    -d '{
    "tasks": {
        "import-frist-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/zombies.pdf"
        },
        "import-second-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/logo.png"
        },
        "archive-my-files": {
            "operation": "archive",
            "input": [
                "import-frist-file",
                "import-second-file"
            ],
            "output_format": "zip"
        },
        "export-my-file": {
            "operation": "export/url",
            "input": "archive-my-files"
        }
    }
}'

use \CloudConvert\CloudConvert;
use \CloudConvert\Models\Job;
use \CloudConvert\Models\Task;

$cloudconvert = new CloudConvert(['api_key' => 'API_KEY']);

$job = (new Job())
   ->addTask(
       (new Task('import/url', 'import-frist-file'))
         ->set('url', 'https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/zombies.pdf')
     )
   ->addTask(
       (new Task('import/url', 'import-second-file'))
         ->set('url', 'https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/logo.png')
     )
   ->addTask(
       (new Task('archive', 'archive-my-files'))
         ->set('input', ["import-frist-file","import-second-file"])
         ->set('output_format', 'zip')
     )
   ->addTask(
       (new Task('export/url', 'export-my-file'))
         ->set('input', 'archive-my-files')
     ); 

$cloudconvert->jobs()->create($job);

import CloudConvert from 'cloudconvert';

const cloudConvert = new CloudConvert('api_key');

let job = await cloudConvert.jobs.create({
    "tasks": {
        "import-frist-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/zombies.pdf"
        },
        "import-second-file": {
            "operation": "import/url",
            "url": "https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/logo.png"
        },
        "archive-my-files": {
            "operation": "archive",
            "input": [
                "import-frist-file",
                "import-second-file"
            ],
            "output_format": "zip"
        },
        "export-my-file": {
            "operation": "export/url",
            "input": "archive-my-files"
        }
    }
});

import cloudconvert

cloudconvert.configure(api_key='API_KEY')

cloudconvert.Job.create(payload={
    'tasks': {
        'import-frist-file': {
            'operation': 'import/url',
            'url': 'https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/zombies.pdf'
        },
        'import-second-file': {
            'operation': 'import/url',
            'url': 'https://cloudconvert-blog.s3.eu-central-1.amazonaws.com/public/test-files/logo.png'
        },
        'archive-my-files': {
            'operation': 'archive',
            'input': [
                'import-frist-file',
                'import-second-file'
            ],
            'output_format': 'zip'
        },
        'export-my-file': {
            'operation': 'export/url',
            'input': 'archive-my-files'
        }
    }
})

Use the Job Builder to generate and try out archive jobs.

PDF Operations

Convert, optimize and manipulate PDF files

File Metadata

Extract and write file metadata