Overview
The FileVerbs Word Conversion provides tools to convert, manipulate, and extract content from DOCX and DOC files. Whether you're converting Word to PDF or removing blank pages, the API supports a wide range of transformations.
Key Features
- Format Coverage: Convert DOCX to PDF, HTML, Markdown, SVG, and more.
- Manipulation: Add or delete comments, insert watermarks, and remove blank pages.
- Advanced Extraction: Extract metadata, comments, and images from Word files.
- Multi-File Support: Split or merge Word documents, control page ranges.
Supported Word Actions
The following actions are available for Word files, grouped by category:
Document Conversions
- WordToPdf: Convert Word document to standard PDF format.
- WordToPdfEmbeddedFonts: Export Word to PDF with embedded fonts to preserve text styling.
- WordToPdfPassword: Convert to PDF and apply password protection.
- WordToHtml: Convert Word to clean HTML for web use.
- WordToHtmlEmbedded: Generate HTML with all images and styles embedded inline.
- WordToMarkdown: Convert Word to lightweight Markdown (.md) format.
- WordToEpub: Convert to EPUB format for e-readers and mobile devices.
- WordToOdt: Convert to OpenDocument Text (.odt) format.
- WordToRtf: Convert Word to Rich Text Format (.rtf).
- WordToCsv: Extract and export Word tables to CSV format.
- WordToText: Extract plain text content from the Word document.
- WordToSvg: Convert Word pages to Scalable Vector Graphics (.svg).
- WordToTiff: Convert Word document to multi-page TIFF image.
- WordToXps: Export Word to XML Paper Specification (.xps).
Word Manipulation
- WordPageRange: Convert selected pages.
- WordSplitter: Split Word document into parts.
- WordAddComment, WordDeleteComment: Manage Word comments.
- WordAddWatermark: Add watermark to Word document.
- WordReplaceText: Replace specified text in Word document.
- WordRemoveBlankPages: Remove empty pages.
- WordMergeMultipleFiles: Merge multiple Word documents.
Extraction
- WordExtractMetadata: Extract metadata from Word.
- WordExtractComments: Extract comments to JSON.
- WordExtractImages: Extract embedded images.
- WordToTextWithOcr: Extract text including OCR for image-based content.
How It Works
- File Upload: Upload your PDF files via the File Upload endpoint to receive a fileId.
- Job Request: Submit a job request, specifying the desired action (e.g., convert PDF to DOCX) and the associated fileId.
- Track Progress: Use the Job Status endpoint to track the progress of your job (e.g., In Progress, Completed).
- Download Outputs: Once the job is completed, retrieve the output file via the Download endpoint.
Example Job Request
{
"action": "wordtopdf",
"parameters": {
"fileIds": ["6810b7dbf7605af74c010127"],
"options": {
"outputSettings": {
"outputFileName": "converted_document.pdf"
}
}
}
}
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.