FileVerbs API Documentation - PDF Conversion Overview

PDF Conversion Overview

Overview

The FileVerbs PDF Conversion provides powerful tools to convert, manipulate, and enhance PDF files. Whether you're looking to convert PDFs to various formats or apply transformations such as watermarks, headers, or page numbers, the API supports a wide range of operations.

Key Features

  • Comprehensive Format Support: Convert PDFs to popular document formats such as DOCX, Excel, and PowerPoint, or image formats like PNG and JPEG.
  • Manipulation Options: Add watermarks, headers, and footers, or split and merge PDFs.
  • Scalable Processing: Handle large files and multiple concurrent requests through our asynchronous job request system.
  • Customization: Apply custom options, such as image resolution or encryption, for a tailored conversion experience.

Supported PDF Actions

The following actions are available for PDF files, grouped by categories:

Document Conversions

  • PdfToDoc: Convert PDF to editable DOC format.
  • PdfToDocx: Convert PDF to DOCX format.
  • PdfToXlsx: Convert PDF to Excel (XLSX) format.
  • PdfToSingleSheet: Convert PDF to a single Excel sheet.
  • PdfToXls: Convert PDF to Excel (XLS) format.
  • PdfToPowerPoint: Convert PDF to PowerPoint (PPTX).
  • PdfToCsv: Convert PDF to CSV format.
  • PdfToOds: Convert PDF to OpenDocument Spreadsheet (ODS).
  • PdfToXmlSpreadsheet: Convert PDF to XML Spreadsheet format.
  • PdfToEpub: Convert PDF to EPUB format for eBooks.
  • PdfToText: Extract plain text from PDF files.
  • PdfToLatex: Convert PDF to LaTeX.
  • PdfToXps: Convert PDF to XPS (XML Paper Specification).

Image Conversions

  • PdfToPng: Convert PDF pages to PNG images.
  • PdfToJpeg: Convert PDF pages to JPEG images.
  • PdfToBmp: Convert PDF pages to BMP images.
  • PdfToGif: Convert PDF pages to GIF images.
  • PdfToTiff: Convert PDF pages to TIFF images.
  • PdfToEmf: Convert PDF pages to EMF vector images.
  • PdfToSvg: Convert PDF pages to SVG (Scalable Vector Graphics).

PDF Manipulation

  • PdfMerge: Merge multiple PDF documents into one.
  • PdfSplit: Split a PDF into multiple smaller documents.
  • PdfWatermark: Add a watermark to your PDF.
  • PdfHeaderFooter: Add headers and footers to your PDF.
  • PdfPageNumber: Add page numbers to your PDF.
  • PdfBackground: Add a background image or color to your PDF.
  • PdfRotation: Rotate pages within your PDF.
  • PdfDeletePage: Delete specified pages from your PDF.
  • PdfCompress: Compress PDF to reduce file size.
  • PdfSplitByBookmark: Split PDF into parts based on bookmark levels.
  • PdfPageReorder: Reorder PDF pages based on a specific order.
  • PdfFlatten: Flatten form fields and annotations to make them non-editable.
  • PdfAddComment: Add comments or annotations to specific locations in your PDF.
  • PdfDeleteComment: Delete annotation comments from PDF pages.

Security

  • PdfEncrypt: Encrypt your PDF with a password.
  • PdfDecrypt: Remove encryption from a PDF.
  • PdfRedact: Automatically redact sensitive keywords in the document.

Extraction

  • PdfExtractAttachments: Extract embedded file attachments from PDF.
  • PdfExtractBookmarks: Extract bookmarks and outlines from PDF.
  • PdfExtractTables: Extract tables from PDF and export as CSV or JSON.
  • PdfTextByArea: Extract text from specific rectangular regions in the PDF.

How It Works

  1. File Upload: Upload your PDF files via the File Upload endpoint to receive a fileId.
  2. Job Request: Submit a job request, specifying the desired action (e.g., convert PDF to DOCX) and the associated fileId.
  3. Track Progress: Use the Job Status endpoint to track the progress of your job (e.g., In Progress, Completed).
  4. Download Outputs: Once the job is completed, retrieve the output file via the Download endpoint.

Example Job Request


{
    "action": "pdftodocx",
    "parameters": {
        "fileIds": ["66b357061b7f9c2032d6d70f"],
        "options": {
            "outputSettings": {
                "outputFileName": "converted_document.docx"
            }
        }
    }
}
                        

Real-Time Job Status Tracking

Once a job request is submitted, you can track the status using the job status endpoint. Possible statuses include:

  • Created: The job has been submitted but not yet processed.
  • In Progress: The job is currently being processed.
  • Completed: The job has been successfully completed, and the output is ready for download.
  • Failed: The job encountered an error during processing.