Process

POST https://api.visualpdf.com/v1/process

Process a pipeline by uploading files and executing the given tasks.

To send files to process as well as the tasks to be performed on these files, you must send the content in multipart/form-data format.

Parameters

Example

Request (NodeJS)

    
      const myPDF = fs.readFileSync('@/path/to/a/doc.pdf');

      const form = new FormData();
      form.append('myPDF', myPDF);
      form.append('tasks', [
        {
          tool: 'compress',
          options: { level: 'high' },
        },
      ]);

      const requestResponse = await fetch(
        'https://api.visualpdf.com/v1/process',
        {
          method: 'POST',
          body: form,
          headers: { Authorization: `Bearer ${my_API_key}` },
        },
      );
    
  

Response

    
      {
        pipelineid: '6ecd8c99-4036-403d-bf84-cf8400f67836',
        duration: 823,
        files: [
          {
            name: 'compress_1',
            id: '40e6215d-b5c6-4896-987c-f30f3678f608',
            link: 'https://api.visualpdf.com/v1/download/40e6215d-b5c6-4896-987c-f30f3678f608',
          },
        ],
        status: 'succeeded',
        started: '2024-05-29T16:08:43.511Z',
      }
    
  

Task object

Available tools

• add-password: Add PDF password. options
• compress: Compress PDF. options
• crop-pages: Crop pages. options
• delete-pages: Delete pages. options
• duplicate-pages: Duplicate pages. options
• excel-to-pdf: Excel to PDF. options
• images-to-pdf: Images to PDF. options
• merge: Merge PDFs. options
• order-pages: Order pages. options
• pdf-to-images: PDF to images. options
• ppt-to-pdf: PowerPoint to PDF. options
• remove-password: Remove PDF password. options
• rotate-pages: Rotate pages. options
• sign: Sign PDF. options
• split: Split/extract PDF pages. options
• watermark: Add watermark. options
• word-to-pdf: Word to PDF. options

Task options

Add PDF password

Example

    
      {
        tool: 'add-password',
        options: { password: 'my_sup3r_s3cr3t_pwd' },
      }
    
  

Compress PDF

Example

    
      {
        tool: 'compress',
        options: { level: 'high' },
      }
    
  

Crop pages

Example

    
      {
        tool: 'crop-pages',
        options: { pages: [{ page: 'all', box: [10, 20, 300, 200] }] },
      }
    
  

Delete pages

Example

    
      {
        tool: 'delete-pages',
        options: { pages: [0, { range: ['last-1', 'last'] }] },
      }
    
  

Duplicate pages

Example

    
      {
        tool: 'duplicate-pages',
        options: { pages: [{ page: 0, duplicates: 2, position: 'last' }] },
      }
    
  

Excel to PDF

This tool does not offer additional options.

Example

    
      {
        tool: 'excel-to-pdf',
      }
    
  

Images to PDF

Example

    
      {
        tool: 'images-to-pdf',
        options: {
            'page-size': 'A4',
            margins: '10h',
          }
      }
    
  

Merge PDFs

Example

    
      {
        tool: 'merge',
        options: { order: [1, 0] },
      }
    
  

Order pages

Example

    
      {
        tool: 'order-pages',
        options: { pages: [{ page: 0, shift: 2 }, { page: 'last', position: 0 }] },
      }
    
  

PDF to images

Example

    
      {
        tool: 'pdf-to-images',
        options: { pages: ['all'] },
      }
    
  

PowerPoint to PDF

This tool does not offer additional options.

Example

    
      {
        tool: 'ppt-to-pdf',
      }
    
  

Remove PDF password

Example

    
      {
        tool: 'remove-password',
        options: { password: 'pwd_t0_r3m0v3' },
      }
    
  

Rotate pages

Example

    
      {
        tool: 'rotate-pages',
        options: { pages: [{ page: 'all', rotation: 90 }] },
      }
    
  

Sign PDF

Example

    
      {
        tool: 'sign',
        options: {
          signatures: [
            {
              box: [30, 50, 150, 100],
              file: 'signature-1',
              pages: ['last'],
            },
          ],
        },
      }
    
  

Split/extract PDF pages

Example

    
      {
        tool: 'split',
        options: { cuts: ['last/2'] },
      }
    
  

Add watermark

Example

    
      {
        tool: 'sign',
        options: {
          watermarks: [
            {
              box: ['50w', '50h', 300, 300],
              text: 'confidential',
              color: '#ff0000',
              font: 'special-elite',
              rotation: -45,
              opacity: 0.5,
              pages: ['all'],
            },
          ],
        },
      }
    
  

Word to PDF

This tool does not offer additional options.

Example

    
      {
        tool: 'word-to-pdf',
      }
    
  

Pipeline options

Errors