{ "openapi": "3.0.1", "info": { "title": "ConvertAPI", "description": "# High-Performance File Conversion API\nConvert Word, Excel, PowerPoint, HTML, PDF and Image formats with our powerful file conversion service.\nWe support more than [200 file types.]( https://www.convertapi.com/doc/file-formats)", "termsOfService": "https://www.convertapi.com/terms", "contact": { "url": "https://www.convertapi.com/support", "email": "support@convertapi.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "v2", "x-ca-converter-tags": { "pdf": { "name": "pdf", "metaTitle": "PDF REST APIs", "metaDescription": "Convert PDF documents to DOCX, PPTX, and XLSX programmatically using a fast REST API conversion service. Easily turn PDF documents into editable files.", "pageTitle": "PDF REST APIs", "friendlyName": "PDF", "summary": "The API for converting and manipulating PDF files", "description": "Convert your PDF documents to DOCX, PPTX, or XLSX files programmatically using our fast and secure REST API conversion service. With this API you can easily convert textual and scanned PDF documents to a Word, PowerPoint, Excel, or plain text file, extract tables from textual and scanned PDF documents to comma-separated values CSV files as well as MS Office spreadsheets, and generate editable Powerpoint presentations.", "category": "Format" }, "pdfa": { "name": "pdfa", "metaTitle": "PDF/A REST APIs", "metaDescription": "The API for converting various types of documents like MS Word and PDF files to standardized PDF/A-1b, PDF/A-2b, and PDF/A-3b files for long-term storage.", "pageTitle": "PDF/A REST APIs", "friendlyName": "PDF/A", "summary": "Convert various documents to a standardized PDF/A format", "description": "PDF/A is a standardized format for the long-term archiving and preservation of electronic documents. It ensures content integrity and accessibility for proper rendering between different software platforms. Our service provides API tools for converting various types of documents like MS Word and PDF files to PDF/A-1b, PDF/A-2b, and PDF/A-3b files for long-term storage.", "category": "Format" }, "postscript": { "name": "postscript", "metaTitle": "PostScript REST APIs", "metaDescription": "Secure and reliable PostScript conversion REST API service, providing EPS, PRN, and PS file conversions to PDF or image formats like JPEG, PNG, TIFF, or WEBP.", "pageTitle": "PostScript REST APIs", "friendlyName": "PostScript", "summary": "Reliable PostScript file conversions", "description": "Secure and reliable PostScript conversion REST API service, providing EPS, PRN, and PS file conversions to PDF or image formats like JPEG, PNG, TIFF, or WEBP. Each conversion provides a bunch of useful conversion properties. Convert your PostScript documents with any programming language at ease using our fast and scalable conversion service.", "category": "Format" }, "modify": { "name": "modify", "metaTitle": "Modify PDF REST APIs", "metaDescription": "Apply document modifications to PDF documents, such as delete or rotate PDF pages, split or merge PDF documents using our fast and secure REST APIs.", "pageTitle": "Document Modification REST APIs", "friendlyName": "Modify", "summary": "Modify PDF documents using our fast and secure REST APIs", "description": "Remove unnecessary pages, adjust the orientation, or manage the document structure using our REST API. Deleting pages from a PDF is simple and precise, ideal for refining your documents and removing irrelevant content. Rotating PDF pages becomes a breeze, allowing you to correct the layout with just a few clicks. Additionally, our split and merge functionalities provide you with the flexibility to rearrange and combine PDF files accordingly.", "category": "Action" }, "extract": { "name": "extract", "metaTitle": "Data extraction REST APIs", "metaDescription": "Advanced content extraction: Convert PDF to DOCX, XLSX, PPTX, CSV, extract images, metadata, and FDF data efficiently.", "pageTitle": "Extract REST APIs", "friendlyName": "Extract", "summary": "Extract content and images from your documents at ease", "description": "Our services are designed to meet the diverse needs of content extraction, whether for professional or personal use. Convert your PDFs into editable DOCX, XLSX, PPTX, or CSV formats with precision, making it easier to handle and repurpose your data. Our tool extracts images maintaining the quality of the original ones. Additionally, our service facilitates the extraction of PDF metadata, and form data in FDF format, ideal for data analysis and reporting.", "category": "Action" }, "ocr": { "name": "ocr", "metaTitle": "OCR REST APIs", "metaDescription": "Convert scanned documents to editable formats like DOCX, XLSX, TXT, and more. Make PDFs searchable with our advanced OCR technology.", "pageTitle": "OCR REST APIs", "friendlyName": "Ocr", "summary": "Turn Scans into Editable & Searchable Files", "description": "Our Optical Character Recognition technology transforms your scanned PDFs into editable and searchable formats with unparalleled accuracy. Whether you're converting to DOCX, XLSX, or TXT, our OCR solution ensures that your documents are easily editable. Additionally, we offer the capability to add a textual layer to scanned PDFs, making them fully searchable and allowing for efficient content extraction. ", "category": "Action" }, "security": { "name": "security", "metaTitle": "Document Security REST APIs", "metaDescription": "Enhance document security with password protection for DOCX, PPTX, and PDF files. Reliable encryption and decryption services.", "pageTitle": "Security REST APIs", "friendlyName": "Security", "summary": "Password Protect & Decrypt Documents Efficiently", "description": "Our services provide robust password protection for DOCX and PPTX files, ensuring that your sensitive information remains confidential and secure. In addition to protecting your documents, we also offer advanced PDF protection and decryption services. Secure your PDFs with a strong password to control viewing, printing, and editing, or use our decryption service to regain access to your protected PDFs with ease.", "category": "Action" }, "autocad": { "name": "autocad", "metaTitle": "AutoCAD REST APIs", "metaDescription": "Export your DWG, DWF, DXF, DWGX, DWFX files to multiple image formats like JPG, PNG, TIFF, WEBP, or even PDF documents programmatically using REST API.", "pageTitle": "AutoCAD REST APIs", "friendlyName": "AutoCAD", "summary": "Accurate AutoCAD file conversions", "description": "Our REST API service is tailored for professionals who require quick and reliable conversion of AutoCAD files such as DWG, DWF, DXF, DWGX, and DWFX into various image formats like JPG, PNG, TIFF, WEBP, or even into PDF documents. Whether you're an architect, engineer, or designer, our tool ensures that your detailed AutoCAD drawings are accurately represented in the format of your choice.", "category": "Format" }, "optimize": { "name": "optimize", "metaTitle": "Optimize REST APIs", "metaDescription": "Master file optimization: Image/document compression, PDF flattening, rasterization and repair for enhanced performance.", "pageTitle": "Optimize REST APIs", "friendlyName": "Optimize", "summary": "Smart document and image optimization", "description": "A comprehensive suite of tools designed to enhance your files' efficiency and quality. Advanced image and document compression techniques to reduce file sizes without losing quality. Discover the power of PDF optimization through flattening and rasterization techniques, ensuring your documents are not only compact but also visually impeccable.", "category": "Action" }, "template": { "name": "template", "metaTitle": "Document Template REST APIs", "metaDescription": "Create custom DOCX and PDF documents with our template-based solution. Inject values into placeholders for personalized output using REST API.", "pageTitle": "Template REST APIs", "friendlyName": "Template", "summary": "Customize DOCX/PDF Templates Easily", "description": "Our service is tailored for users who need to generate documents based on specific templates. Whether you’re preparing business reports, official letters, or any other type of document, our tool allows for the easy injection of custom values into pre-defined placeholders. This feature is particularly useful for businesses and individuals who require consistent document layouts with varying content.", "category": "Action" }, "compare": { "name": "compare", "metaTitle": "Compare REST APIs", "metaDescription": "Effortlessly compare documents for changes using our fast and secure REST API service. Ideal for editing, collaboration, and document management.", "pageTitle": "Compare REST APIs", "friendlyName": "Compare", "summary": "Quick & Accurate File Comparisons", "description": "Our document compare tools are designed for anyone who needs to track changes and differences in text documents efficiently. It accurately highlights changes between different versions of a DOCX file, allowing you to easily see additions, deletions, and modifications. This feature is indispensable for ensuring consistency and accuracy in document editing and version control.", "category": "Action" }, "archive": { "name": "archive", "metaTitle": "Archive REST APIs", "metaDescription": "Archive more than 100+ file formats to ZIP, encrypt with a password, and choose from different compression levels programmatically using REST API.", "pageTitle": "Archive REST APIs", "friendlyName": "Archive", "summary": "Fast and secure archive automation", "description": "Our archive converters are designed to handle over 100 different file formats, making it a versatile tool for a wide range of archiving needs. Archive your files securely with options for password encryption, ensuring that your data remains safe during transfer and storage. It allows for varying levels of compression as per your needs. Extracting files from ZIP archives is just as efficient and user-friendly!", "category": "Action" }, "office": { "name": "office", "metaTitle": "Microsoft Office REST APIs", "metaDescription": "Convert your MS Office documents with any programming language at ease using our fast and secure conversion service. A complete MS Office REST API.", "pageTitle": "Microsoft Office REST APIs", "friendlyName": "Office", "summary": "Seamless Microsoft Office conversions", "description": "A complete MS Office suite conversion REST API service. Easily convert to and from DOCX, XLSX, PPTX, RTF, TXT, CSV, PDF, and much more. Each conversion provides a bunch of useful conversion properties. Convert your MS Office documents with any programming language at ease using our fast and secure conversion service.", "category": "Format" }, "openoffice": { "name": "openoffice", "metaTitle": "OpenOffice REST APIs", "metaDescription": "A complete OpenOffice suite conversion REST API service. Easily convert to and from ODT, OTT, OTH, ODM, SXW, RTF, TXT, CSV, PDF, and much more.", "pageTitle": "OpenOffice REST APIs", "friendlyName": "OpenOffice", "summary": "Flexible OpenOffice format conversions", "description": "A complete OpenOffice suite conversion REST API service. Easily convert to and from ODT, OTT, OTH, ODM, SXW, RTF, TXT, CSV, PDF, and much more. Each conversion provides a bunch of useful conversion properties. Convert your OpenOffice documents with any programming language at ease using our fast and secure conversion service.", "category": "Format" }, "markdown": { "name": "markdown", "metaTitle": "Markdown REST APIs", "metaDescription": "Efficiently convert HTM/HTML files to Markdown (MD) format, perfect for web developers and content creators.", "pageTitle": "Markdown REST APIs", "friendlyName": "Markdown", "summary": "Markdown to document conversions", "description": "Markdown REST APIs provide tools for converting HTM and HTML files to Markdown (MD) format. Our converters ensure that your HTML structures are accurately transformed into clean, concise Markdown syntax. Whether you're looking to streamline content management, simplify website updates, or convert web pages to a format that's easier to edit and version control, our HTML to Markdown conversion tools are here to help.", "category": "Format" }, "ebook": { "name": "ebook", "metaTitle": "eBooks REST APIs", "metaDescription": "Convert your eBooks to a PDF document or image like PNG, JPG, TIFF, or WEBP programmatically using our fast and secure REST API with any programming language.", "pageTitle": "eBooks REST APIs", "friendlyName": "eBooks", "summary": "eBook format conversion APIs", "description": "Convert your eBooks to a PDF document or image like PNG, JPG, TIFF, or WEBP programmatically using our fast and secure REST API with any programming language you choose. You can choose from a bunch conversion parameters when converting an eBook. Your eBook can be further compressed, encrypted or merged after you convert it to a PDF document.", "category": "Format" }, "html": { "name": "html", "metaTitle": "Web & HTML REST APIs", "metaDescription": "Convert webpages, HTM, HTML, and MHML files to multiple destination formats like a PDF, PNG, JPEG, etc. using our fast and reliable REST API conversion service.", "pageTitle": "Web & HTML REST APIs", "friendlyName": "Web & HTML", "summary": "HTML and web content conversions", "description": "Convert webpages, HTM, HTML, and MHML files to multiple destination formats using our fast and reliable REST API conversion service. Converters allow multiple advanced options like converting websites that are secured with basic authentication, lets you inject your custom JS or CSS, hide adds, cookie consent dialogs and more.", "category": "Format" }, "spreadsheet": { "name": "spreadsheet", "metaTitle": "Spreadsheet REST APIs", "metaDescription": "Efficiently convert between MS Office Excel and iWork Numbers formats. Seamless spreadsheet conversion for accurate data management.", "pageTitle": "Spreadsheet REST APIs", "friendlyName": "Spreadsheet", "summary": "Spreadsheet format conversion APIs", "description": "Our comprehensive tools cover a wide range of conversions, including from and to MS Office Excel and iWork Numbers formats. We also specialize in converting PDF files to XLSX, ensuring your data is editable and manageable. Need to present your Excel data in a universally accessible format? Convert your XLSX files to PDF with ease. Our services also extend to converting CSV files to XLSX and vice versa, perfect for handling large data sets. ", "category": "Format" }, "publishing": { "name": "publishing", "metaTitle": "Publishing REST APIs", "metaDescription": "Convert PUB, XPS, OXPS files to PDF, PNG, and more. Optimal solutions for all your publishing file conversion needs.", "pageTitle": "Publishing REST APIs", "friendlyName": "Publishing", "summary": "Professional publishing file conversions", "description": "Our service caters to users of Microsoft Office Publisher, offering efficient and high-quality conversions of PUB files to popular formats such as JPG, PNG, TIFF, and PDF. In addition to that, we offer advanced conversion services for XPS and OXPS files conversion to PDF and PNG. Our conversion process retains the layout, design, and color integrity of your original files, ensuring that the essence of your work is preserved.", "category": "Format" }, "document": { "name": "document", "metaTitle": "Document REST APIs", "metaDescription": "Effortlessly convert to and from various document formats. Reliable, fast, and accurate document conversion for all your Word needs.", "pageTitle": "Document REST APIs", "friendlyName": "Document", "summary": "Seamless Various Document Conversions", "description": "Whether you're converting from textual documents to PDF, image, HTML, or vice-versa, our service guarantees fast, accurate, and reliable results. This is ideal for professionals who require quick turnarounds and high-quality document handling. In addition to basic format conversions, our tools also support advanced features to maintain formatting, styles, and layouts, ensuring that your documents look professional and remain consistent across conversions.", "category": "Format" }, "presentation": { "name": "presentation", "metaTitle": "Presentation REST APIs", "metaDescription": "Transform presentations effortlessly with our REST APIs conversion tools. Convert PDF to PPTX, KEY to PPTX, and more with ease.", "pageTitle": "Presentation REST APIs", "friendlyName": "Presentation", "summary": "Accurate Presentation Conversions at Scale", "description": "Specializing in a variety of PowerPoint conversions, our tools make it easy to transform your presentations. Key features include converting PDF files to PPTX format and converting KEY (Apple Keynote) files to PPTX, ensuring compatibility and ease of use across different platforms. Our advanced technology maintains the integrity of your original layout, graphics, and animations, making the conversion process smooth and reliable.", "category": "Format" }, "email": { "name": "email", "metaTitle": "Email REST APIs", "metaDescription": "Secure and reliable email conversion REST API service, providing EML, MBX, MSG, and OFT file conversions to PDF, PDFA, or image with multiple parameters.", "pageTitle": "Email REST APIs", "friendlyName": "Email", "summary": "Convert & Extract Emails at Scale", "description": "Secure and reliable email conversion REST API service, providing EML, MBX, MSG, and OFT file conversions to PDF, PDFA, or image. You can choose whether to convert email attachments or not. You can also choose if you want to include the email's metadata like from, to, subject, and date into the selected destination format.", "category": "Format" }, "image": { "name": "image", "metaTitle": "Image REST APIs", "metaDescription": "A powerful image converter SDK for all programming languages. Convert BMP, FAX, GIF, HEIC, ICO, JPEG, MDI, PNG, TIFF, or WEBP files to PDF or image.", "pageTitle": "Image REST APIs", "friendlyName": "Image", "summary": "High-Quality Image Conversions", "description": "We support a wide range of image formats, including BMP, FAX, GIF, HEIC, ICO, JPEG, MDI, PNG, TIFF, and WEBP. Whether you need to convert these images to PDF for document inclusion or to other popular image formats for various uses, our tools are equipped to handle your requirements with precision. Additionally, our service offers the functionality to apply watermarks to your images, ensuring your content protection and personalization.", "category": "Format" }, "watermark": { "name": "watermark", "metaTitle": "Watermark PDF API: Image, Text & PDF Overlay Stamps", "metaDescription": "Integrate REST watermark APIs to stamp PDFs with image, text, or PDF overlay marks. Control font, color, position, opacity, rotation, and page ranges.", "pageTitle": "PDF Watermark APIs", "friendlyName": "Watermark", "summary": "Stamp image, text, or PDF overlay watermarks on PDFs via REST API", "description": "Integrate watermark functionality into your applications via REST endpoints for stamping PDF documents. Apply image watermarks from PNG, JPG, or TIFF files. Add text watermarks with control over font, size, color, stroke, opacity, and rotation. Overlay another PDF page as a vector watermark across selected pages. Every request accepts precise placement parameters including coordinates, scale, page ranges, opacity, and clickable links. Use these endpoints to brand contracts, mark drafts as confidential, apply copyright notices, or automate batch document labeling inside your pipeline.", "category": "Action" }, "drawing": { "name": "drawing", "metaTitle": "Drawing REST APIs", "metaDescription": "Effortlessly convert Microsoft Visio diagrams to PDF, JPEG, PNG, and TIFF. Preserve quality with our advanced conversion tools.", "pageTitle": "Drawing REST APIs", "friendlyName": "Drawing", "summary": "Technical Drawing File Conversions", "description": "Converting drawings to various formats is streamlined and efficient. Our services are specifically tailored for professionals who utilize Visio for detailed diagrams and need versatile output options. Whether you need to convert your Visio diagrams to PDF for documentation purposes, JPEG or PNG for high-quality image formats, or TIFF for archiving and printing, our tools ensure that your diagrams maintain their integrity and quality.", "category": "Format" }, "forms": { "name": "forms", "metaTitle": "Extract, Import PDF form data", "metaDescription": "Streamline PDF forms and FDF file handling with our conversion tools. Extract and import form data effortlessly for efficient data management.", "pageTitle": "PDF Form REST APIs", "friendlyName": "Form", "summary": "Efficient PDF & FDF Form Data Handling Tools", "description": "Simplify your workflow by enabling efficient extraction and import of form data. Whether you're dealing with complex PDF forms or need to handle FDF files, our platform offers seamless, user-friendly solutions. Perfect for businesses and individuals who regularly work with form data, our tools ensure accuracy and save time. Enjoy the ease of extracting data from forms for analysis, or importing data into forms for quick completion. ", "category": "Action" }, "ai": { "name": "ai", "metaTitle": "AI-Powered REST APIs", "metaDescription": "Leverage AI to automate content detection and transformation across file formats with our secure, efficient, and intelligent REST API solutions.", "pageTitle": "AI-Powered REST APIs", "friendlyName": "AI Tools", "summary": "AI-powered detection and transformation", "description": "Our AI-powered REST API automatically detects and transforms content across different file formats with advanced algorithms. From text redaction to document structuring, our intelligent solution simplifies complex tasks, ensuring efficiency and security without manual intervention. Streamline your document workflows and rely on AI for smarter, faster, and more accurate content processing.", "category": "Action" }, "barcode": { "name": "barcode", "metaTitle": "Barcode & QR Code REST APIs", "metaDescription": "Generate, detect, and decode high-quality barcodes and QR codes from data or documents with our REST API. Supports Code 128, QR Code, EAN-13, and more.", "pageTitle": "Barcode & QR Code REST APIs", "friendlyName": "Barcode", "summary": "High-Quality Barcode and QR Code Solutions", "description": "Generate high-quality barcode and QR code images from data, or detect and decode them from documents and images using our REST API. We support a wide range of industry-standard formats, including Code 128, Code 39, EAN-13, QR Code, and Data Matrix. You can fully customize the generation process or use advanced detection algorithms to extract data from various file formats accurately.", "category": "Action" }, "einvoice": { "name": "einvoice", "metaTitle": "E-Invoice REST APIs", "metaDescription": "Convert e-invoices between ZUGFeRD, Factur-X, and Peppol BIS Billing 3.0 (UBL), or render Peppol invoices to PDF. Fast, secure, EN 16931 compliant REST API.", "pageTitle": "E-Invoice REST APIs", "friendlyName": "E-Invoice", "summary": "Convert and render EN 16931 electronic invoices", "description": "Work with structured electronic invoices through a single fast and secure REST API. Convert ZUGFeRD or Factur-X documents - supplied as CII XML or embedded inside a PDF/A-3 - into Peppol BIS Billing 3.0 UBL XML ready for the Peppol network, with every EN 16931 field mapped and the output validated against the official Peppol Schematron rules. You can also render a Peppol invoice into a clean, human-readable PDF using the bundled template or your own branded layout. Automate compliant e-invoicing end to end, directly from your accounting or ERP system.", "category": "Format" } } }, "servers": [ { "url": "https://v2.convertapi.com" }, { "url": "https://eu-v2.convertapi.com" }, { "url": "https://uk-v2.convertapi.com" }, { "url": "https://us-v2.convertapi.com" }, { "url": "https://ca-v2.convertapi.com" }, { "url": "https://as-v2.convertapi.com" }, { "url": "https://au-v2.convertapi.com" } ], "paths": { "/upload": { "post": { "tags": [ "File Server" ], "summary": "Upload file", "description": "When source files require multiple conversions, optimizing performance is possible by uploading the file once and then performing multiple conversions without the need for re-uploading.\nThe uploaded file is securely stored on the convertapi.com server for a maximum period of 3 hours and can be accessed through a unique secret URL with a UUID.\nIn conversion requests, the file can be referenced using the File ID, which is generated upon successful file upload.\n", "externalDocs": { "url": "https://www.convertapi.com/doc/upload" }, "parameters": [ { "name": "filename", "in": "query", "description": "File name.\nRequired if the header field `content-disposition` is not set.\n", "schema": { "type": "string" }, "example": "myfile.pdf" }, { "name": "content-disposition", "in": "header", "description": "This header field is used to determine the file name.\n**Required** if query parameter `filename` is not set.\nQuery parameter `filename` overrides this parameter.\n", "schema": { "type": "string" }, "example": "Content-Disposition: inline; filename=\"myfile.pdf\"" }, { "name": "fileId", "in": "query", "description": "Custom ID for the file that is uploaded. Lowercase alphanumeric character string.", "schema": { "$ref": "#/components/schemas/fileId" }, "example": "25811safe8e61dd3f51ef00ee5f58b92" }, { "name": "url", "in": "query", "description": "Remote file URL. The URL of the file you want to upload and store on the ConvertAPI file server.\nIf the file is accessible by the URL, it can be uploaded directly from its location by passing the URL instead of the file itself.\n", "schema": { "type": "string", "format": "uri" }, "example": "https://example.com/myfile.pdf" }, { "name": "headername", "in": "query", "description": "Remote file request header field name (used exclusively in conjunction with the `url` parameter).", "schema": { "type": "string" }, "example": "header-field-name" }, { "name": "headervalue", "in": "query", "description": "Remote file request header field value (used exclusively in conjunction with the `url` and `headername` parameters).", "schema": { "type": "string" }, "example": "Header field value" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The file to upload", "format": "binary" } } }, "example": "There can be only one part with file data.\n```http\n[POST]\nhttps://v2.convertapi.com/upload \nContent-Type: multipart/form-data; boundary=----7MA4YWxkTrZu0gW\n\n------7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"file\"; filename=\"my_file.doc\"\n\n--FILE DATA--\n------7MA4YWxkTrZu0gW--\n```\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "example": "```http\n[POST]\nhttps://v2.convertapi.com/upload \nContent-Disposition: inline; filename=\"my_file.doc\"\n\n--FILE DATA--\n```\n" } } }, "responses": { "200": { "description": "The file to upload", "content": { "application/json": { "schema": { "type": "object", "properties": { "FileName": { "type": "string", "example": "myfile.docx" }, "FileExt": { "type": "string", "example": "docx" }, "FileSize": { "type": "integer", "format": "int32", "example": "1026736" }, "FileId": { "type": "string", "example": "9shcxkk4zvesuzl2xavmg9afqbr2ty62" }, "Url": { "type": "string", "format": "uri", "example": "https://v2.convertapi.com/d/9shcxkk4zvesuzl2xavmg9afqbr2ty62" } } } }, "text/plain": { "schema": { "format": "string", "example": "9shcxkk4zvesuzl2xavmg9afqbr2ty62" } } } }, "400": { "description": "File request with an invalid file ID" }, "415": { "description": "The file type is not supported" }, "500": { "description": "Unable to store or download remote file" } } } }, "/d/{fileId}": { "get": { "tags": [ "File Server" ], "summary": "Download file", "operationId": "download", "parameters": [ { "$ref": "#/components/parameters/fileId" }, { "name": "download", "in": "query", "description": "- `attachment` - download a file\n- `inline` - view file in a web browser\n", "schema": { "enum": [ "attachment", "inline" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "content-disposition": { "$ref": "#/components/headers/content-disposition" }, "file-name": { "$ref": "#/components/headers/file-name" }, "file-ext": { "$ref": "#/components/headers/file-ext" }, "file-size": { "$ref": "#/components/headers/file-size" } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "File not found" } } }, "delete": { "tags": [ "File Server" ], "summary": "Delete file", "description": "If the file is no longer required it can be deleted. Otherwise, it will be automatically deleted after 3 hours.", "parameters": [ { "$ref": "#/components/parameters/fileId" } ], "responses": { "200": { "description": "File deleted successfuly" }, "404": { "description": "File not found" } } }, "head": { "tags": [ "File Server" ], "summary": "Get file information", "parameters": [ { "$ref": "#/components/parameters/fileId" } ], "responses": { "200": { "description": "Success", "headers": { "content-disposition": { "$ref": "#/components/headers/content-disposition" }, "file-name": { "$ref": "#/components/headers/file-name" }, "file-ext": { "$ref": "#/components/headers/file-ext" }, "file-size": { "$ref": "#/components/headers/file-size" } } }, "404": { "description": "File not found" } } } }, "/user": { "get": { "tags": [ "User" ], "summary": "User information", "description": "The endpoint returns information about a user account. It is helpful to check the account balance status and other data. The endpoint can be authenticated only with a secret, the token is not accepted.\n", "externalDocs": { "url": "https://www.convertapi.com/doc/user" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "Active": { "type": "boolean", "description": "User can perform conversions" }, "Email": { "type": "string", "description": "User email", "example": "user@example.com" }, "Secret": { "type": "string", "description": "Authentication secret", "example": "1XKrszdaFZH33WTh" }, "ApiKey": { "type": "integer", "description": "Authentication API key", "format": "int64", "example": 842679918 }, "ConversionsTotal": { "type": "integer", "description": "Plan conversion count", "format": "int64", "example": 5000 }, "ConversionsConsumed": { "type": "integer", "description": "Conversions consumed", "format": "int64", "example": 458 }, "SecondsLeft": { "type": "integer", "format": "int64", "deprecated": true }, "FullName": { "type": "string", "description": "User full name", "example": "John Wick" } } } } } }, "401": { "$ref": "#/components/responses/401" } }, "security": [ { "secret": [ ] } ] } }, "/user/statistic": { "get": { "tags": [ "User" ], "summary": "Statistics", "description": "The endpoint that returns information about your usage statistics based on the date range.", "externalDocs": { "url": "https://www.convertapi.com/doc/user" }, "parameters": [ { "name": "startDate", "in": "query", "description": "Conversions from date", "required": true, "schema": { "type": "string" }, "example": "2023-09-01" }, { "name": "endDate", "in": "query", "description": "Conversions to date", "required": true, "schema": { "type": "string" }, "example": "2023-09-30" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Result": { "type": "boolean", "description": "Is conversion successful" }, "CreatedAt": { "type": "string", "description": "Conversion time" }, "ExecutionTime": { "type": "integer", "description": "Conversion duration", "format": "int32" }, "Converter": { "type": "string", "description": "File converter name" }, "SourceFormat": { "type": "string", "description": "Source file format (docx, pdf, jpg etc.)" }, "DestinationFormat": { "type": "string", "description": "Destination file format (docx, pdf, jpg etc.)" }, "Ip": { "type": "string", "description": "File conversion request origin IP" }, "Source": { "type": "string", "description": "Source file name" }, "Error": { "type": "string", "description": "Conversion error message" } } } } }, "text/csv": { "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/400" } }, "security": [ { "secret": [ ] } ] } }, "/convert/pdf/to/compress": { "summary": "Compress PDF API", "description": "Reduce PDF file size up to 90% by optimizing images, fonts, and removing unused objects while preserving visual quality.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-compress" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Preset": { "enum": [ "none", "lossless", "text", "archive", "web", "ebook", "printer" ], "type": "string", "description": "Choose a compression level from the available presets. If a preset is selected, all other compression options will be ignored. These presets are optimized for various use cases, such as balancing file size and quality.", "default": "none", "x-ca-featured": true, "x-ca-label": "Compression preset", "x-ca-group": "Compression", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "Not set - advanced properties used", "lossless": "Lossless - losslessly attempt to reduce file size", "text": "Text - 20 image DPI, lowest quality, highest compression", "archive": "Archive - 40 image DPI, low quality, high compression", "web": "Web - 75 image DPI, medium quality, high compression", "ebook": "Ebook - 150 image DPI, high quality, medium compression", "printer": "Printer - 300 image DPI, high quality, low compression" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set the maximum image resolution in DPI.", "default": 150, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image Compression", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set image quality in percentage.", "default": 80, "x-ca-featured": false, "x-ca-label": "Image quality", "x-ca-group": "Image Compression", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "UnembedBaseFonts": { "type": "boolean", "description": "Specifies whether to remove the base fonts from the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Unembed base fonts", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SubsetEmbeddedFonts": { "type": "boolean", "description": "Output PDF should only contain font characters utilized in the original document, and any unused glyphs from all fonts in the document should be removed.", "default": false, "x-ca-featured": false, "x-ca-label": "Subset embedded fonts", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveForms": { "type": "boolean", "description": "Remove PDF forms from the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove forms", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveDuplicates": { "type": "boolean", "description": "Remove duplicate fonts and color profiles from the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove duplicates", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Optimize": { "type": "boolean", "description": "Optimize page content streams in the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Optimize content", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemovePieceInformation": { "type": "boolean", "description": "Remove piece information dictionaries like Adobe Illustrator or Photoshop private data.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove piece information", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveEmbeddedFiles": { "type": "boolean", "description": "Remove embedded/attachments files from the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove embedded files", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveStructureInformation": { "type": "boolean", "description": "Remove all structure information from the PDF document.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove structure information", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveMetadata": { "type": "boolean", "description": "Detach the XMP metadata embedded in the document from its catalog, clear all properties in all schemas, and remove metadata from marked content.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove metadata", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveUnusedResources": { "type": "boolean", "description": "Remove references to resources such as fonts, images, patterns.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove unused resources", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Linearize": { "type": "boolean", "description": "Linearize PDF file and optimize for fast Web View.", "default": false, "x-ca-featured": false, "x-ca-label": "Linearize", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PreservePdfa": { "type": "boolean", "description": "Preserve the PDF/A standard in the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Preserve PDF/A", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The Compress PDF API by ConvertAPI is a tool that allows for the compression and reduction of PDF file sizes by up to 90%. This API optimizes PDF quality by compressing text, graphics, images, subsetting fonts, and optimizing document structure. It offers various parameters for customization, including compression presets, color and grayscale image compression, and options to remove elements like bookmarks, annotations, forms, and embedded files from the PDF. The API also provides options for optimizing the PDF for web viewing and preserving the PDF/A standard.\n", "x-ca-overview-markdown": "The Compress PDF API by ConvertAPI is a tool that allows for the compression and reduction of PDF file sizes by up to 90%. This API optimizes PDF quality by compressing text, graphics, images, subsetting fonts, and optimizing document structure. It offers various parameters for customization, including compression presets, color and grayscale image compression, and options to remove elements like bookmarks, annotations, forms, and embedded files from the PDF. The API also provides options for optimizing the PDF for web viewing and preserving the PDF/A standard.", "x-ca-meta-title": "Efficient PDF Compression API - Up to 90% Size Reduction", "x-ca-meta-description": "Efficiently reduce PDF size with Compress PDF API. Experience up to 90% compression while preserving quality. Ideal for both individual and professional needs.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "optimize", "pdf", "featured" ] }, "/convert/pdf/to/crop": { "summary": "Crop PDF API", "description": "Crop PDF pages with margins, exact size, or auto-detect content area with page ranges and multiple measurement units.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-crop" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range to convert. The parameter understands digits and the keywords even, odd and last. Example: 1,2,5-last.", "default": "1-last", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "CropMode": { "enum": [ "auto", "size", "margins" ], "type": "string", "description": "Defines how pages are cropped: automatic content detection, cropping by margins, or cropping to an exact size using width/height or paper size.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Crop mode", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto (detect content)", "size": "Size (width/height)", "margins": "Margins" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Specifies measurement unit to use for the page height and page width properties.", "default": "in", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "AutoStrategy": { "enum": [ "perPage", "uniform" ], "type": "string", "description": "Defines whether automatic cropping is applied per page or uniformly across all pages. Takes effect when `CropMode` is set to `Auto`.", "default": "uniform", "x-ca-featured": false, "x-ca-label": "Auto strategy", "x-ca-group": "Auto Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "perPage": "Per Page", "uniform": "Uniform" } }, "AutoPadding": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Padding to add around detected content, using the selected measurement unit. Takes effect when `CropMode` is set to `Auto`.", "default": 0, "x-ca-featured": false, "x-ca-label": "Auto padding", "x-ca-group": "Auto Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "Anchor": { "enum": [ "center", "topleft", "top", "topright", "left", "right", "bottom", "bottomright" ], "type": "string", "description": "Anchor position to place the crop rectangle when crop height and crop width are defined.", "default": "center", "x-ca-featured": false, "x-ca-label": "Anchor", "x-ca-group": "Size Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "center": "Center", "topleft": "Top Left", "top": "Top", "topright": "Top Right", "left": "Left", "right": "Right", "bottom": "Bottom", "bottomright": "Bottom Right" } }, "PageSize": { "enum": [ "custom", "a2", "a3", "a4", "a5", "a6", "letter", "legal" ], "type": "string", "description": "Crops each page to the selected standard page size. Set Crop width and/or Crop height to override it.", "default": "a4", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Size Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "custom": "Custom", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "letter": "Letter", "legal": "Legal" } }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Set page orientation.", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Size Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "CropWidth": { "maximum": 30000, "minimum": 1, "type": "number", "description": "Width of the crop box, expressed in the selected measurement unit. Takes effect when `CropMode` is set to `Size`. When set, it overrides `PageSize` for the horizontal axis, leave it empty to crop the width to the selected `PageSize`.\r\n", "x-ca-featured": false, "x-ca-label": "Crop width", "x-ca-group": "Size Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "30000" } }, "CropHeight": { "maximum": 30000, "minimum": 1, "type": "number", "description": "Height of the crop box, expressed in the selected measurement unit. Takes effect when `CropMode` is set to `Size`. When set, it overrides `PageSize` for the vertical axis, leave it empty to crop the height to the selected `PageSize`.\r\n", "x-ca-featured": false, "x-ca-label": "Crop height", "x-ca-group": "Size Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "30000" } }, "VerticalMargin": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Top and bottom margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.", "default": 1, "x-ca-featured": false, "x-ca-label": "Vertical margin", "x-ca-group": "Margins Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "HorizontalMargin": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Left and right margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.", "default": 1, "x-ca-featured": false, "x-ca-label": "Horizontal margin", "x-ca-group": "Margins Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The Crop PDF API lets you precisely trim PDF pages. Choose automatic content detection with optional padding, crop by exact width/height anchored to a page corner or center, or crop by setting horizontal/vertical margins. Combine with page ranges and measurement units (points, inches, millimeters, centimeters).\n", "x-ca-overview-markdown": "The Crop PDF API lets you precisely trim PDF pages. Choose automatic content detection with optional padding, crop by exact width/height anchored to a page corner or center, or crop by setting horizontal/vertical margins. Combine with page ranges and measurement units (points, inches, millimeters, centimeters).", "x-ca-meta-title": "Crop PDF API - Auto, Margins, or Exact Size Cropping", "x-ca-meta-description": "Crop PDF pages via API. Auto-detect content with padding, crop by margins, or set exact width/height with anchor. Supports page ranges and measurement units.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf" ] }, "/convert/pdf/to/csv": { "summary": "PDF to CSV API", "description": "Extract tables from PDF documents to CSV files with password support, page range selection, optional OCR, and delimiter control.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-csv" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Delimiter", "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "EnableOcr": { "enum": [ "Scanned", "All", "None" ], "type": "string", "description": "Enable optical character recognition(OCR). Set the property to ALL to perform OCR on all pages and Scanned to perform OCR on scanned pages if PDF contains mixed pages - text and image pages.", "default": "Scanned", "x-ca-featured": false, "x-ca-label": "Enable OCR", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Scanned": "Scanned Only", "All": "All Pages", "None": "None" } }, "OcrLanguage": { "enum": [ "ar", "ca", "zh-cn", "zh-tw", "da", "nl", "en", "fi", "fa", "de", "el", "he", "it", "ja", "ko", "lt", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Set the OCR language. Ask support to add your language if missing.", "default": "en", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "ar": "Arabic", "ca": "Catalan", "zh-cn": "Chinese Simplified", "zh-tw": "Chinese Traditional", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fa": "French", "de": "German", "el": "Greek", "he": "Hebrew", "it": "Italian", "ja": "Japanese", "ko": "Korean", "lt": "Lithuanian", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "Delimiter": { "type": "string", "description": "Set fields separator.", "default": ",", "x-ca-featured": true, "x-ca-label": "Fields separator", "x-ca-group": "CSV", "x-ca-type": "String", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Extract tables from textual and scanned PDF documents to comma-separated values CSV files. The API identifies bordered and border-less tabular structures within pdf documents and extracts these tables to a list of CSV formatted files.\n", "x-ca-overview-markdown": "Extract tables from textual and scanned PDF documents to comma-separated values CSV files. The API identifies bordered and border-less tabular structures within pdf documents and extracts these tables to a list of CSV formatted files.", "x-ca-meta-title": "PDF to CSV API – Extract tables from PDF to CSV files", "x-ca-meta-description": "Extract tables from PDF documents to CSV files. Detects tabular structures in textual and scanned PDFs with optional OCR and delimiter control.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "csv", "x-ca-tags": [ "pdf", "extract" ] }, "/convert/pdf/to/delete-pages": { "summary": "Delete PDF Pages API", "description": "Remove selected pages or ranges from PDF files with password support and automatic blank page deletion for clean output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-delete-pages" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to delete. Example 1-10 or 1,2,5.", "x-ca-featured": true, "x-ca-label": "Delete Page Range", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "20000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "DeleteBlankPages": { "type": "boolean", "description": "Automatically detect and delete blank pages.", "default": false, "x-ca-featured": false, "x-ca-label": "Delete Blank Pages", "x-ca-group": "Document", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Remove unwanted pages from PDF documents with precise control over scope and behavior. Provide a page list or ranges to delete (for example, 1,3-5,10) and optionally remove blank pages automatically to tidy scans. Open password‑protected PDFs when required and limit changes to a specific range to protect other content. Designed for automation, the API processes single files or batches consistently, producing clean, focused PDFs for distribution, review, and archival.\n", "x-ca-overview-markdown": "Remove unwanted pages from PDF documents with precise control over scope and behavior. Provide a page list or ranges to delete (for example, 1,3-5,10) and optionally remove blank pages automatically to tidy scans. Open password‑protected PDFs when required and limit changes to a specific range to protect other content. Designed for automation, the API processes single files or batches consistently, producing clean, focused PDFs for distribution, review, and archival.", "x-ca-meta-title": "Delete PDF Pages API – Remove pages and ranges in PDFs", "x-ca-meta-description": "Remove selected pages or ranges from PDFs via API. Supports passwords, deletion of blank pages, and produces clean, focused documents.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf" ] }, "/convert/pdf/to/docx": { "summary": "PDF to DOCX API", "description": "Convert PDFs to editable DOCX preserving layout, text, images, and tables with password, page ranges, layout mode, and OCR.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-docx" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Layout": { "enum": [ "flowing", "continuous", "exact" ], "type": "string", "description": "Controls how the original PDF page layout is reconstructed in the output: choose `flowing` to produce editable flowing text, `continuous` to preserve the layout using continuous text frames, or `exact` to reproduce the page pixel-perfectly using text boxes.", "default": "flowing", "x-ca-featured": false, "x-ca-label": "Layout", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "flowing": "Flowing", "continuous": "Continuous", "exact": "Exact" } }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "Annotations": { "enum": [ "textBox", "comment", "none" ], "type": "string", "description": "Set how PDF annotations are handled in the DOCX output: choose `textBox` to place each annotation as an editable text box near its anchor, `comment` to convert annotations into Word comments attached to the relevant text, or `none` to omit all annotations from the result.", "default": "textBox", "x-ca-featured": false, "x-ca-label": "Annotations", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "textBox": "TextBox", "comment": "Comment", "none": "None" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Effortlessly Convert PDFs to MS Word DOCX with the PDF to Word API. Our API offers robust features such as layout preservation, formatting retention, table handling, and OCR-powered text extraction from scanned PDFs. Experience the convenience of a clean, user-friendly Word document. What sets us apart is our RESTful API design, ensuring seamless integration into your applications or websites. Just make a simple PDF to DOCX API call, and watch your PDFs transform into editable Word documents quickly and efficiently.\n", "x-ca-overview-markdown": "Effortlessly Convert PDFs to MS Word DOCX with the PDF to Word API. Our API offers robust features such as layout preservation, formatting retention, table handling, and OCR-powered text extraction from scanned PDFs. Experience the convenience of a clean, user-friendly Word document. What sets us apart is our RESTful API design, ensuring seamless integration into your applications or websites. Just make a simple PDF to DOCX API call, and watch your PDFs transform into editable Word documents quickly and efficiently.", "x-ca-meta-title": "PDF to DOCX Conversion API – Convert PDF to Editable Word", "x-ca-meta-description": "Convert PDFs to DOCX via API. Preserve layout, text, images, and tables. Handle passwords and ranges. Choose layout reconstruction mode and OCR for scanned inputs.", "x-ca-keywords": "pdf, docx, word, office", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "docx", "x-ca-tags": [ "pdf", "extract", "document", "featured" ] }, "/convert/pdf/to/extract": { "summary": "Extract PDF API", "description": "AI-powered extraction of structured data from invoices, receipts, and forms with custom fields and confidence levels.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-extract" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "DocumentType": { "enum": [ "auto", "invoice", "receipt", "contract", "identification", "financial", "form", "manual" ], "type": "string", "description": "The `DocumentType` parameter specifies the type of document you're processing, enabling the AI to precisely extract structured data based on the selected document category. Selecting the correct document type improves extraction accuracy by applying optimized data extraction rules tailored for each category. Choose manual if you prefer to exclusively define `CustomExtractionData` parameter.\r\n\r\nSelect the DocumentType that matches your document:\r\n\r\n- **Auto** - Attempts to identify the document as one of the listed types and applies the corresponding extraction rules.\r\n\r\n- **Invoice** - Extract structured data from invoices, including invoice number, dates, totals, vendor details, and line items.\r\n\r\n- **Receipt** - Optimized extraction for payment receipts, capturing dates, totals, vendor details, and payment methods.\r\n\r\n- **Contract** - Captures critical details from contracts or agreements, including parties involved, dates, terms, and conditions.\r\n\r\n- **Identification** - Designed for identification documents like passports, driver's licenses, or national ID cards, extracting names, dates, document numbers, and other identifying information.\r\n\r\n- **Financial** - Specifically targets financial documents, including bank statements and transaction records, extracting transaction dates, amounts, balances, and descriptions.\r\n\r\n- **Form** - Extracts structured data from standard forms containing predefined fields, ideal for surveys, applications, and questionnaires.\r\n\r\n- **Manual** - Disables predefined AI document extraction presets. Only manually configured extraction parameters are used, giving full control to the user.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Document Type", "x-ca-group": "AI Detection Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Automatically Detect Document Type", "invoice": "Invoice", "receipt": "Receipt or Payment Slip", "contract": "Contract / Agreement", "identification": "Identification Document (ID, passport, etc.)", "financial": "Bank Statement / Transaction Records", "form": "Form with Structured Fields", "manual": "Custom Extraction Only" } }, "CustomExtractionData": { "type": "string", "description": "A JSON array defining specific values to extract.\r\n\r\n#### Example JSON\r\n\r\n```json\r\n[\r\n {\r\n \"FieldName\": \"TotalResult\",\r\n \"Extract\": \"total price\"\r\n },\r\n {\r\n \"FieldName\": \"ServiceName\",\r\n \"Extract\": \"most expensive service name\"\r\n }\r\n]\r\n```", "x-ca-featured": false, "x-ca-label": "Custom Extraction Data", "x-ca-group": "AI Detection Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "MinimumConfidence": { "maximum": 0.99, "minimum": 0.01, "type": "number", "description": "Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.", "default": 0.5, "x-ca-featured": false, "x-ca-label": "Minimum confidence", "x-ca-group": "AI Detection Options", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.01", "to": "0.99" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Automatically extract key information from invoices, receipts, forms, and other documents. Whether you're automating business workflows, simplifying data entry, or streamlining document processing, our AI-powered text extraction tool offers accurate, fast, and user-friendly data extraction solutions. Start transforming your documents into structured data today with our reliable Data Extraction API.\n", "x-ca-overview-markdown": "Automatically extract key information from invoices, receipts, forms, and other documents. Whether you're automating business workflows, simplifying data entry, or streamlining document processing, our AI-powered text extraction tool offers accurate, fast, and user-friendly data extraction solutions. Start transforming your documents into structured data today with our reliable Data Extraction API.", "x-ca-meta-title": "Extract Data from Documents with AI - Data Extraction API", "x-ca-meta-description": "Easily extract structured data from invoices, receipts, and forms using AI or JSON. Automate document processing with our smart PDF Data Extraction API.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "json", "x-ca-tags": [ "ai", "extract", "pdf" ] }, "/convert/pdf/to/extract-attachments": { "summary": "Extract PDF Attachments API", "description": "Extract embedded file attachments from PDF documents and save them in their original formats with full content preserved.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-extract-attachments" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "IncludeAnnotationAttachments": { "type": "boolean", "description": "Include attachments embedded as page-level file attachment annotations", "default": true, "x-ca-featured": false, "x-ca-label": "Include Annotation Attachments", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Utilize our Extract PDF Attachments API to retrieve and save embedded files from PDF documents in their original formats. This API allows you to access attachments such as Office documents, images, archives, e-invoices or any other files embedded within a PDF, preserving their original structure and quality. Ideal for professionals working with complex PDF documents containing supplementary files, our API provides a reliable and efficient solution for managing embedded content and streamlining document workflows.\n", "x-ca-overview-markdown": "Utilize our Extract PDF Attachments API to retrieve and save embedded files from PDF documents in their original formats. This API allows you to access attachments such as Office documents, images, archives, e-invoices or any other files embedded within a PDF, preserving their original structure and quality. Ideal for professionals working with complex PDF documents containing supplementary files, our API provides a reliable and efficient solution for managing embedded content and streamlining document workflows.", "x-ca-meta-title": "Extract PDF Attachments API – Save Embedded Files from PDF", "x-ca-meta-description": "Extract PDF Attachments API to easily retrieve and save embedded files from PDF documents in their original formats.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "any", "x-ca-tags": [ "pdf", "extract" ] }, "/convert/pdf/to/extract-images": { "summary": "Extract PDF Images API", "description": "Extract embedded images from PDF files to PNG, JPG, or TIFF with page range selection, resolution control, and size filtering.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-extract-images" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "ImageOutputFormat": { "enum": [ "default", "jpg", "png", "tiff" ], "type": "string", "description": "Set image type when extracting images from PDF. If the `Default` value is set, the API will use the most suitable image format for the extracted image and extract all images, even those not visible on pages but present in PDF. When the `Default` value is set, the `ImageResolution` property are ignored.", "default": "default", "x-ca-featured": true, "x-ca-label": "Image format", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "jpg": "JPG", "png": "PNG", "tiff": "TIFF" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "MinimumImageWidth": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "Set minimum image width in pixels. Images narrower than this value are ignored.", "default": 10, "x-ca-featured": false, "x-ca-label": "Minimum Image Width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } }, "MinimumImageHeight": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "Set minimum image height in pixels. Images shorter than this value are ignored.", "default": 10, "x-ca-featured": false, "x-ca-label": "Minimum Image Height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Utilize our Extract PDF Images API to effortlessly find and save images from PDF files into popular formats like PNG, JPG, or TIFF. This API allows you to customize your outputs, including selecting specific page ranges and adjusting the resolution to suit your project's requirements. Ideal for professionals needing high-quality image extraction from documents, our API provides a reliable and efficient solution for managing digital content.\n", "x-ca-overview-markdown": "Utilize our Extract PDF Images API to effortlessly find and save images from PDF files into popular formats like PNG, JPG, or TIFF. This API allows you to customize your outputs, including selecting specific page ranges and adjusting the resolution to suit your project's requirements. Ideal for professionals needing high-quality image extraction from documents, our API provides a reliable and efficient solution for managing digital content.", "x-ca-meta-title": "Extract PDF Images API – Save to PNG, JPG, or TIFF", "x-ca-meta-description": "Extract PDF Images API to easily find and save PDF images to PNG, JPG, or TIFF. Set properties like page range and resolution.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "jpg,png,tiff", "x-ca-tags": [ "pdf", "extract", "image" ] }, "/convert/pdf/to/fdf-extract": { "summary": "Extract PDF Form API", "description": "Extract PDF form fields to FDF format with password support, alternate field names, and clean portable output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-fdf-extract" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "IncludeAlternateNames": { "type": "boolean", "description": "Include alternate field names (/TU) from the PDF as tooltips in the FDF output.", "default": false, "x-ca-featured": false, "x-ca-label": "Include alternate names", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Extract interactive form data from PDF into FDF, a lightweight, standardized format for exchanging PDF form values. Open password‑protected PDFs when required, and optionally include alternate field names to improve downstream mapping and interoperability. The resulting FDF file contains structured key‑value pairs that are easy to integrate with databases, workflow systems, or validation tools. Ideal for ingestion pipelines, e‑forms processing, and cross‑platform exchange where compact, portable form data is needed.\n", "x-ca-overview-markdown": "Extract interactive form data from PDF into FDF, a lightweight, standardized format for exchanging PDF form values. Open password‑protected PDFs when required, and optionally include alternate field names to improve downstream mapping and interoperability. The resulting FDF file contains structured key‑value pairs that are easy to integrate with databases, workflow systems, or validation tools. Ideal for ingestion pipelines, e‑forms processing, and cross‑platform exchange where compact, portable form data is needed.", "x-ca-meta-title": "Extract PDF Forms to FDF API - Extract PDF Form Data to FDF", "x-ca-meta-description": "Extract PDF form fields to FDF. Handle passwords and include alternate names for reliable mapping and system integration.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "fdf", "x-ca-tags": [ "pdf", "forms", "extract" ] }, "/convert/pdf/to/fdf-import": { "summary": "FDF to PDF API", "description": "Import FDF form data into PDF documents with field mapping by name, password support, and ready-to-use output files.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-fdf-import" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "FdfFile", "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FdfFile": { "type": "string", "description": "Specifies the FDF file that contains structured form data. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "FDF file", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "fdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Import FDF (Forms Data Format) into PDF documents that contain corresponding interactive form fields. Field values are mapped by name and written into the appropriate PDF form fields to produce an updated, ready‑to‑use document. Handle password‑protected PDFs when required and validate that the form structure matches the FDF schema before applying changes. Designed for automation, the API delivers predictable results for e‑forms processing, records management, and downstream approval workflows.\n", "x-ca-overview-markdown": "Import FDF (Forms Data Format) into PDF documents that contain corresponding interactive form fields. Field values are mapped by name and written into the appropriate PDF form fields to produce an updated, ready‑to‑use document. Handle password‑protected PDFs when required and validate that the form structure matches the FDF schema before applying changes. Designed for automation, the API delivers predictable results for e‑forms processing, records management, and downstream approval workflows.", "x-ca-meta-title": "FDF to PDF API – Import form data FDF file into PDF forms", "x-ca-meta-description": "Import FDF data into PDF via API. Map fields by name, handle passwords, validate form structure, and output updated PDFs for workflows.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf", "forms" ] }, "/convert/pdf/to/flatten": { "summary": "Flatten PDF API", "description": "Flatten PDF forms and annotations into the page content to prevent further editing and ensure document integrity and security.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-flatten" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "FlattenControls": { "type": "boolean", "description": "Prevent form controls such as text fields, checkboxes, and dropdowns from being edited by converting them into static page content while preserving their original appearance in the PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Controls", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FlattenWidgets": { "type": "boolean", "description": "Prevent widget annotations such as buttons, list boxes, and signature fields from being interactive by converting them into static page content while preserving their original appearance in the PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Widgets", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FlattenText": { "type": "boolean", "description": "Prevent text selection, copying, and extraction by turning the textual symbols into vectorial paths to make the PDF read-only while preserving the original vectorial PDF quality.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Text", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Flatten PDF API is a tool that secures PDF documents by locking interactive elements and preserving their visual layout. It ensures form fields and annotations cannot be modified, while offering the ability to protect text from selection, copying, and extraction by converting it into vector paths. This makes the PDF fully read-only without compromising its original quality.\n", "x-ca-overview-markdown": "Flatten PDF API is a tool that secures PDF documents by locking interactive elements and preserving their visual layout. It ensures form fields and annotations cannot be modified, while offering the ability to protect text from selection, copying, and extraction by converting it into vector paths. This makes the PDF fully read-only without compromising its original quality.", "x-ca-meta-title": "Flatten PDF API: Flatten Form Fields and Entire Document", "x-ca-meta-description": "Flatten PDF API is a tool that allows you to lock PDF form fields and prevent text copying by turning the textual symbols into vectorial paths to make the PDF read-only.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "optimize", "pdf" ] }, "/convert/pdf/to/html": { "summary": "PDF to HTML API", "description": "Convert PDFs to HTML preserving layout, text, images, and tables with password, page ranges, WYSIWYG mode, and OCR support.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-html" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Wysiwyg": { "type": "boolean", "description": "Persist exact formatting using text boxes.", "default": true, "x-ca-featured": false, "x-ca-label": "Exact Formatting", "x-ca-group": "Html", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Easily convert PDFs to HTML using our PDF to HTML API. Enhance accessibility and user interaction by seamlessly transforming PDF content. Our conversion process preserves text, images, and formatting, ensuring accuracy. Experience fast and efficient conversions that save you time and resources.\n", "x-ca-overview-markdown": "Easily convert PDFs to HTML using our PDF to HTML API. Enhance accessibility and user interaction by seamlessly transforming PDF content. Our conversion process preserves text, images, and formatting, ensuring accuracy. Experience fast and efficient conversions that save you time and resources.", "x-ca-meta-title": "PDF to HTML Conversion API – Convert PDF to HTML File", "x-ca-meta-description": "Convert PDFs to HTML via API. Preserve layout, text, images, and tables; handle passwords and ranges; use WYSIWYG and OCR for scans.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "html", "x-ca-tags": [ "pdf", "extract", "html", "featured" ] }, "/convert/pdf/to/image-watermark": { "summary": "Image Watermark PDF API", "description": "Add image watermark to PDF using PNG, JPG, or TIFF files with control over scale, opacity, position, links, and style.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-image-watermark" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "ImageFile" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "ImageFile": { "type": "string", "description": "Specifies the image file to use as watermark. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "Image file", "x-ca-group": "Watermark", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "jpg", "jpeg", "png", "tiff" ] }, "Style": { "enum": [ "stamp", "watermark" ], "type": "string", "description": "Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.", "default": "watermark", "x-ca-featured": true, "x-ca-label": "Watermark style", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "stamp": "Stamp", "watermark": "Watermark" } }, "Opacity": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Specifies watermark opacity level.", "default": 100, "x-ca-featured": false, "x-ca-label": "Opacity level", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "100" } }, "GoToLink": { "type": "string", "description": "Specifies the web address to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to web link", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "GoToPage": { "type": "string", "description": "Specifies the page number to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to page", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRotation": { "type": "boolean", "description": "Specifies whether the watermark should respect the PDF page rotation. When enabled, the watermark is rotated together with the page. When disabled, the watermark is placed ignoring page rotation.", "default": false, "x-ca-featured": false, "x-ca-label": "Use page rotation", "x-ca-group": "Watermark", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageBox": { "enum": [ "mediabox", "trimbox", "bleedbox", "cropbox" ], "type": "string", "description": "Specifies the PDF page box used as the reference area for applying the watermark.", "default": "mediabox", "x-ca-featured": false, "x-ca-label": "PageBox", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "mediabox": "MediaBox", "trimbox": "TrimBox", "bleedbox": "BleedBox", "cropbox": "CropBox" } }, "HorizontalAlignment": { "enum": [ "left", "center", "right" ], "type": "string", "description": "Specifies the horizontal watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Horizontal watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "left": "Left", "center": "Center", "right": "Right" } }, "VerticalAlignment": { "enum": [ "top", "center", "bottom" ], "type": "string", "description": "Specifies the vertical watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Vertical watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "top": "Top", "center": "Center", "bottom": "Bottom" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Measurement unit for position and size parameters.", "default": "pt", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "OffsetX": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the X-axis. Positive values move the watermark to the right, while negative values move it to the left, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in X axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "OffsetY": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the Y-axis. Positive values move the watermark downward, while negative values move it upward, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in Y axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "Scale": { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Specifies the watermark scale in percent.", "default": 100, "x-ca-featured": false, "x-ca-label": "Scale watermark", "x-ca-group": "Size & Position", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "2000" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Apply image-based watermarks to PDF documents for branding, copyright protection, or visual identification. Upload an image file and place it as a watermark on each page with precise control over size, opacity, rotation, and position. Target specific pages or page ranges, choose a watermark style (foreground or background), and optionally add interactive actions such as external links or internal page navigation. The watermark respects page rotation and scaling, ensuring consistent placement across documents in automated and batch workflows.\n", "x-ca-overview-markdown": "Apply image-based watermarks to PDF documents for branding, copyright protection, or visual identification. Upload an image file and place it as a watermark on each page with precise control over size, opacity, rotation, and position. Target specific pages or page ranges, choose a watermark style (foreground or background), and optionally add interactive actions such as external links or internal page navigation. The watermark respects page rotation and scaling, ensuring consistent placement across documents in automated and batch workflows.", "x-ca-meta-title": "Image Watermark PDF API – Add image watermark to PDFs", "x-ca-meta-description": "Add image watermarks to PDFs via API. Use PNG, JPG or TIFF images with control over size, opacity, position, page ranges, links, and style.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "watermark", "pdf", "image", "featured" ] }, "/convert/pdf/to/jpg": { "summary": "PDF to JPG API", "description": "Render PDF pages to JPG images with password support, page range selection, resolution control, and JPEG quality settings.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-jpg" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Rotate": { "enum": [ "default", "none", "rotate90", "rotate180", "rotate270" ], "type": "string", "description": "Set PDF page rotation before converting to image.", "default": "default", "x-ca-featured": false, "x-ca-label": "Rotate page", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "none": "None", "rotate90": "Rotate 90", "rotate180": "Rotate 180", "rotate270": "Rotate 270" } }, "CropTo": { "enum": [ "BoundingBox", "TrimBox", "MediaBox", "ArtBox", "BleedBox" ], "type": "string", "description": "Defines the options for cropping the page.", "default": "BoundingBox", "x-ca-featured": false, "x-ca-label": "Crop to box", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "BoundingBox": "Bounding Box", "TrimBox": "Trim Box", "MediaBox": "Media Box", "ArtBox": "Art Box", "BleedBox": "Bleed Box" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Scale.md.", "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "FitToSize": { "type": "boolean", "description": "Gets or sets whether to scale the output image to fit within both ImageWidth and ImageHeight while maintaining the aspect ratio. When enabled, the image is sized to fit the more restrictive dimension. Requires both width and height to be specified.", "default": false, "x-ca-featured": false, "x-ca-label": "Fit to size", "x-ca-group": "JPG Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BackgroundColor": { "type": "string", "description": "Applies a color to the transparent PDF background, thereby setting the background color of the generated images. You can specify a color name (e.g. `white` or `black`), or use color codes such as RGB (e.g. `255,0,0`) or HEX (e.g. `#FF0000`). To preserve transparency, set the property value to `transparent`.", "x-ca-featured": false, "x-ca-label": "Background Color", "x-ca-group": "JPG Output", "x-ca-type": "Color", "x-ca-representation": "Default" }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ColorSpace": { "enum": [ "rgb", "cmyk", "gray", "monochrome" ], "type": "string", "description": "Set image color space.", "default": "rgb", "x-ca-featured": false, "x-ca-label": "Image color space", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "rgb": "RGB", "cmyk": "CMYK", "gray": "Gray", "monochrome": "Monochrome" } }, "BitDepth": { "enum": [ "default", "1", "2", "4", "8", "16" ], "type": "string", "description": "Set the number of bits per color channel in the output image. Higher values improve color precision and gradient smoothness but increase file size.", "default": "default", "x-ca-featured": false, "x-ca-label": "Bit depth", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "1": "1 bit", "2": "2 bits", "4": "4 bits", "8": "8 bits", "16": "16 bits" } }, "CompressionLevel": { "maximum": 9, "minimum": 0, "type": "integer", "description": "Define the compression level (0–9). A higher value increases compression, reducing file size. For lossy formats (JPG), this decreases image quality; for lossless formats (PNG), it increases compression strength without affecting quality.", "x-ca-featured": false, "x-ca-label": "Compression level", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "9" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to high‑quality JPG images for web, apps, and archival. Handle password‑protected files, restrict processing to specific page ranges, rotate pages to correct orientation, and crop to a target box when needed. Control output with image resolution (DPI), scaling via explicit width/height, color‑space selection for consistent rendering, and JPEG quality to balance fidelity and file size. Generate thumbnails or full‑resolution images in batch with predictable results across varied inputs and workflows.\n", "x-ca-overview-markdown": "Convert PDF documents to high‑quality JPG images for web, apps, and archival. Handle password‑protected files, restrict processing to specific page ranges, rotate pages to correct orientation, and crop to a target box when needed. Control output with image resolution (DPI), scaling via explicit width/height, color‑space selection for consistent rendering, and JPEG quality to balance fidelity and file size. Generate thumbnails or full‑resolution images in batch with predictable results across varied inputs and workflows.", "x-ca-meta-title": "PDF to JPG Conversion API – Convert PDF to JPG Images", "x-ca-meta-description": "Convert PDF to JPG via API. Set page range, resolution, width/height, color space, rotation/crop, and JPEG quality; handle passwords reliably.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "pdf", "image", "featured" ] }, "/convert/pdf/to/json": { "summary": "PDF to JSON API", "description": "Convert PDF documents to structured, layout-aware JSON with text, tables, images, and bounding boxes for AI and data pipelines.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-json" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "IncludeGraphics": { "type": "boolean", "description": "Include vector graphic elements in the JSON output.", "default": true, "x-ca-featured": false, "x-ca-label": "Include Graphics", "x-ca-group": "Json", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExtractTableRows": { "type": "boolean", "description": "Reconstruct table rows and cells from the detected table layout.", "default": true, "x-ca-featured": false, "x-ca-label": "Extract Table Rows", "x-ca-group": "Json", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents into clean, structured JSON built for large language models, retrieval-augmented generation, and automated data pipelines. Every page is decomposed into typed elements - paragraphs, tables, images, and graphics - each carrying its text, reading order, and precise bounding box. Tables are reconstructed into rows and cells so tabular data stays machine-readable for downstream use. Handle password-protected files, target page ranges, and apply OCR to scanned documents so even image-based PDFs yield searchable, structured output for indexing, analytics, and AI ingestion.\n", "x-ca-overview-markdown": "Convert PDF documents into clean, structured JSON built for large language models, retrieval-augmented generation, and automated data pipelines. Every page is decomposed into typed elements - paragraphs, tables, images, and graphics - each carrying its text, reading order, and precise bounding box. Tables are reconstructed into rows and cells so tabular data stays machine-readable for downstream use. Handle password-protected files, target page ranges, and apply OCR to scanned documents so even image-based PDFs yield searchable, structured output for indexing, analytics, and AI ingestion.\r\n", "x-ca-meta-title": "PDF to JSON API - Extract structured PDF data as JSON", "x-ca-meta-description": "Convert PDF documents to structured JSON. Extract text, tables, images, and bounding boxes in reading order for AI, RAG, and data workflows.", "x-ca-keywords": "json, pdf, extract, structured, data", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "json", "x-ca-tags": [ "pdf", "extract" ] }, "/convert/pdf/to/md": { "summary": "PDF to MD API", "description": "Convert PDF to Markdown (MD) with our REST API. Preserve headings, lists, tables, and text structure for AI workflows.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-md" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "ConvertAPI's PDF to Markdown converter transforms PDF documents into clean, structured Markdown (.md) format perfect for modern workflows. Built for AI applications, LLM training datasets, embeddings, RAG pipelines, and content migration to static site generators like Hugo, Jekyll, and MkDocs. The conversion intelligently preserves headings, paragraphs, lists, tables, and text hierarchy, producing readable Markdown that integrates seamlessly with Obsidian, Notion, GitHub, and Git workflows. Process files using simple REST API calls.\n", "x-ca-overview-markdown": "ConvertAPI's PDF to Markdown converter transforms PDF documents into clean, structured Markdown (.md) format perfect for modern workflows. Built for AI applications, LLM training datasets, embeddings, RAG pipelines, and content migration to static site generators like Hugo, Jekyll, and MkDocs. The conversion intelligently preserves headings, paragraphs, lists, tables, and text hierarchy, producing readable Markdown that integrates seamlessly with Obsidian, Notion, GitHub, and Git workflows. Process files using simple REST API calls.", "x-ca-meta-title": "PDF to Markdown REST API for Developers - Convert PDF to MD ", "x-ca-meta-description": "Integrate PDF to Markdown conversion via REST API. Preserves headings, lists, and tables. Built for AI, LLM training, and RAG pipelines. Free API key.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "md", "x-ca-tags": [ "pdf", "markdown", "extract", "document" ] }, "/convert/pdf/to/merge": { "summary": "Merge PDF API", "description": "Combine multiple PDFs into a single, organized document with control over page order, size, orientation, bookmarks, and fonts.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-merge" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Files" ], "type": "object", "properties": { "Files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files to be converted. Value can be URL or file content. If used in query or multipart content parameter must be suffixed with index e.g. Files[0], Files[1], Files[2]...", "x-ca-featured": true, "x-ca-label": "Files", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "RemoveDuplicateFonts": { "type": "boolean", "description": "Do not include the same fonts from source PDFs while merging.", "default": false, "x-ca-featured": true, "x-ca-label": "Remove duplicate fonts", "x-ca-group": "Merge", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BookmarksTableOfContents": { "enum": [ "disabled", "filename", "title" ], "type": "string", "description": "Adds a top-level bookmark for each file, using the filename or PDF title from metadata.", "default": "disabled", "x-ca-featured": true, "x-ca-label": "Add bookmarks table of contents", "x-ca-group": "Merge", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "disabled": "Disabled", "filename": "File Name", "title": "Title" } }, "PageSize": { "enum": [ "default", "a2", "a3", "a4", "a5", "a6", "letter", "legal" ], "type": "string", "description": "Scales each page to match the selected page size during PDF merging.", "default": "default", "x-ca-featured": true, "x-ca-label": "Page size", "x-ca-group": "Merge", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "letter": "Letter", "legal": "Legal" } }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Sets the orientation of each page during PDF merging.", "default": "default", "x-ca-featured": true, "x-ca-label": "Page orientation", "x-ca-group": "Merge", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "OpenPage": { "maximum": 3000, "minimum": 1, "type": "integer", "description": "Set the page number at which the PDF document should open.", "default": 1, "x-ca-featured": false, "x-ca-label": "Open to page", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "3000" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The Merge PDF API allows users to combine multiple PDF files into a single PDF document.\nSome key features of the Merge PDF API include retaining page numbering, eliminating duplicate fonts for improved performance, and generating a table of contents for the merged documents. Additionally, it offers properties like page size to set a consistent page size across the merged document and page orientation to choose between portrait and landscape orientations, ensuring that the final output meets specific formatting requirements.\nThis API is useful for organizing content and reducing the number of separate files by merging them into one.\n", "x-ca-overview-markdown": "The Merge PDF API allows users to combine **multiple PDF files** into a **single PDF document**.\r\n\r\nSome key features of the Merge PDF API include **retaining page numbering**, **eliminating duplicate fonts** for improved performance, and generating a **table of contents** for the merged documents. Additionally, it offers properties like **page size** to set a consistent page size across the merged document and **page orientation** to choose between portrait and landscape orientations, ensuring that the final output meets specific formatting requirements.\r\n\r\nThis API is useful for organizing content and reducing the number of separate files by merging them into one.", "x-ca-meta-title": "Merge PDF API - Merge Multiple PDF Files with Options", "x-ca-meta-description": "Merge PDF API allows developers to combine multiple PDF files into a single document.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf", "featured" ] }, "/convert/pdf/to/meta": { "summary": "Metadata PDF API", "description": "Extract PDF metadata and page counts as JSON with password support for indexing, validation, and automation workflows.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-meta" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Read detailed PDF metadata and page counts to power indexing, validation, and automation. Return key fields such as title, author, subject, keywords, creation and modification dates, producer, version, and total pages in a structured JSON format. Open password‑protected files when required to ensure complete analysis across secured documents. Ideal for ingestion pipelines, compliance checks, content inventories, and quality gates where accurate document properties are essential.\n", "x-ca-overview-markdown": "Read detailed PDF metadata and page counts to power indexing, validation, and automation. Return key fields such as title, author, subject, keywords, creation and modification dates, producer, version, and total pages in a structured JSON format. Open password‑protected files when required to ensure complete analysis across secured documents. Ideal for ingestion pipelines, compliance checks, content inventories, and quality gates where accurate document properties are essential.", "x-ca-meta-title": "PDF Metadata API – Read Metadata and Page Data from PDFs", "x-ca-meta-description": "Extract PDF metadata and page counts as JSON. Handle passwords and use results for indexing, validation, and automation.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "json", "x-ca-tags": [ "pdf", "extract" ] }, "/convert/pdf/to/ocr": { "summary": "PDF OCR API", "description": "Convert scanned PDFs to searchable, editable documents with OCR language selection, recognition modes, and page range control.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-ocr" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "always", "reprocess" ], "type": "string", "description": "The `OcrMode` setting controls how OCR is applied to PDF pages. In `Auto` mode, pages that already contain text are skipped, so OCR runs only where needed. In `Always` mode, OCR is applied to every page, keeping existing text while adding recognition for images and other visual content. In `Reprocess` mode, OCR is performed on the whole page, producing a fresh text layer regardless of what was there before.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "always": "Always", "reprocess": "Reprocess" } }, "OcrLanguage": { "enum": [ "ar", "ca", "zh-cn", "zh-tw", "da", "nl", "en", "fi", "fa", "de", "el", "he", "it", "ja", "ko", "lt", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Set the OCR language. Ask support to add your language if missing.", "default": "en", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "ar": "Arabic", "ca": "Catalan", "zh-cn": "Chinese Simplified", "zh-tw": "Chinese Traditional", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fa": "French", "de": "German", "el": "Greek", "he": "Hebrew", "it": "Italian", "ja": "Japanese", "ko": "Korean", "lt": "Lithuanian", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OutputType": { "enum": [ "pdf", "txt" ], "type": "string", "description": "This property is used to determine how the OCR layer should be returned. If the output type is PDF, the OCR layer will be embedded into the PDF file. Alternatively, if a text output is selected, the OCR layer will be returned as a text file.", "default": "pdf", "x-ca-featured": false, "x-ca-label": "Output Type", "x-ca-group": "Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pdf": "PDF file", "txt": "Text file" } }, "PageSegmentationMode": { "enum": [ "sparseText", "sparseTextOsd", "auto", "autoOsd", "singleLine", "singleColumn", "singleWord" ], "type": "string", "description": "The **PageSegmentationMode** parameter specifies how the OCR engine segments and interprets text within PDF documents. Choosing the appropriate mode enhances OCR accuracy by aligning closely with your document's layout and structure.\r\n\r\nSelect one of the available modes to control text detection and layout analysis:\r\n- **SparseText** - Detects as much text as possible without enforcing any specific order. Suitable for documents containing scattered or fragmented text.\r\n- **SparseTextOsd** - Similar to SparseText, but also includes orientation and script detection (OSD). Useful for documents with rotated text or multiple scripts and languages.\r\n- **Auto** - Automatically selects the best segmentation mode based on document content. Ideal for general documents with mixed or unknown layouts.\r\n- **AutoOsd** - Combines automatic segmentation with orientation and script detection. Recommended for documents with uncertain text orientation or multilingual content.\r\n- **SingleColumn** - Assumes a single column of text with varying text sizes. Best suited for straightforward layouts.\r\n- **SingleLine** - Treats the entire image as a single line of text. Useful for single-line labels, banners, or narrow text snippets.\r\n- **SingleWord** - Treats the entire image as a single word. Ideal for recognizing isolated words or short phrases.", "default": "sparseText", "x-ca-featured": false, "x-ca-label": "Page Segmentation Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "sparseText": "Sparse Text", "sparseTextOsd": "Sparse Text Osd", "auto": "Auto", "autoOsd": "Auto Osd", "singleLine": "Single Line", "singleColumn": "Single Column", "singleWord": "Single Word" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert scanned PDF documents into fully searchable and editable PDFs using accurate OCR. Detect text in page images and add a hidden text layer that preserves the original appearance while enabling selection and indexing. Select OCR languages to maximize accuracy for multilingual content, choose recognition mode and page segmentation, and limit processing to page ranges for faster runs. Handle password‑protected inputs and tune timeouts for large files. Ideal for digitization, compliance, and content discovery.\n", "x-ca-overview-markdown": "Convert scanned PDF documents into fully searchable and editable PDFs using accurate OCR. Detect text in page images and add a hidden text layer that preserves the original appearance while enabling selection and indexing. Select OCR languages to maximize accuracy for multilingual content, choose recognition mode and page segmentation, and limit processing to page ranges for faster runs. Handle password‑protected inputs and tune timeouts for large files. Ideal for digitization, compliance, and content discovery.", "x-ca-meta-title": "PDF OCR API – Convert scanned PDFs to searchable PDFs", "x-ca-meta-description": "Convert scanned PDFs to searchable, editable text using PDF OCR API. Fast, secure, accurate OCR with language and page range control.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "ocr", "ai", "pdf", "featured" ] }, "/convert/pdf/to/pcl": { "summary": "PDF to PCL API", "description": "Convert PDF to PCL for legacy or enterprise printers that require PCL5 for fast, reliable batch printing in high-volume workflows.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pcl" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "ColorMode": { "enum": [ "color", "monochrome" ], "type": "string", "description": "Set output file color mode.", "default": "color", "x-ca-featured": false, "x-ca-label": "Color mode", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color": "Color", "monochrome": "Monochrome" } }, "Resolution": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Defines the resolution for output document, measured in dots per inch (DPI). Higher DPI values produce better image quality but result in larger file sizes.", "default": 300, "x-ca-featured": false, "x-ca-label": "Resolution", "x-ca-group": "Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF files to classic PCL (PCL5) for direct use in print workflows, spoolers, and legacy systems. Generate printer-ready PCL output (monochrome or color) with controllable resolution while preserving page size and layout. Ideal for environments that require PCL files instead of PDF, with no printer drivers or Adobe software required.\n", "x-ca-overview-markdown": "Convert PDF files to classic PCL (PCL5) for direct use in print workflows, spoolers, and legacy systems. Generate printer-ready PCL output (monochrome or color) with controllable resolution while preserving page size and layout. Ideal for environments that require PCL files instead of PDF, with no printer drivers or Adobe software required.", "x-ca-meta-title": "PDF to PCL Conversion API – PDF to PCL5 for Legacy Print", "x-ca-meta-description": "Convert PDF to PCL (PCL5) via API. Produce printer-ready PCL streams for legacy print workflows, with controllable resolution and accurate layout.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pcl", "x-ca-tags": [ "pdf" ] }, "/convert/pdf/to/pdf": { "summary": "PDF to PDF API", "description": "Modify PDF documents by embedding fonts, setting metadata, adjusting viewer preferences, and optimizing color spaces easily.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "EmbedFonts": { "type": "boolean", "description": "Embed fonts in PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Embed fonts", "x-ca-group": "PDF Fonts", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SubsetFonts": { "type": "boolean", "description": "Include in the output PDF document only the font characters that are used in the original document.", "default": true, "x-ca-featured": false, "x-ca-label": "Subset fonts", "x-ca-group": "PDF Fonts", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PdfVersion": { "enum": [ "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "2.0" ], "type": "string", "description": "Set PDF version.", "default": "1.5", "x-ca-featured": false, "x-ca-label": "PDF version", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "1.2": "Acrobat 3 (PDF 1.2)", "1.3": "Acrobat 4 (PDF 1.3)", "1.4": "Acrobat 5 (PDF 1.4)", "1.5": "Acrobat 6 (PDF 1.5)", "1.6": "Acrobat 7 (PDF 1.6)", "1.7": "Acrobat 8 (PDF 1.7)", "1.8": "Acrobat 9 (PDF 1.7, e-level 3)", "2.0": "Acrobat DC (PDF 2.0)" } }, "PdfTitle": { "type": "string", "description": "Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.", "x-ca-featured": false, "x-ca-label": "PDF title", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "PdfSubject": { "type": "string", "description": "Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.", "x-ca-featured": false, "x-ca-label": "PDF subject", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "PdfAuthor": { "type": "string", "description": "Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.", "x-ca-featured": false, "x-ca-label": "PDF author", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "PdfCreator": { "type": "string", "description": "Provide a value to customize the PDF creator. Otherwise, the default document creator will be used. Use single quotes and a space (' ') to remove the creator.", "x-ca-featured": false, "x-ca-label": "PDF creator", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "PdfKeywords": { "type": "string", "description": "Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.", "x-ca-featured": false, "x-ca-label": "PDF keywords", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "OpenPage": { "maximum": 3000, "minimum": 1, "type": "integer", "description": "Set the page number at which the PDF document should open.", "default": 1, "x-ca-featured": false, "x-ca-label": "Open to page", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "3000" } }, "OpenZoom": { "enum": [ "Default", "ActualSize", "FitPage", "FitWidth", "FitHeight", "FitVisible", "25", "50", "75", "100", "125", "150", "200", "400", "800", "1600", "2400", "3200", "6400" ], "type": "string", "description": "Set the default zoom percentage for when you open PDF files .", "default": "Default", "x-ca-featured": false, "x-ca-label": "PDF default zoom", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Default": "Default", "ActualSize": "Actual Size", "FitPage": "Fit Page", "FitWidth": "Fit Width", "FitHeight": "Fit Height", "FitVisible": "Fit Visible", "25": "25%", "50": "50%", "75": "75%", "100": "100%", "125": "125%", "150": "150%", "200": "200%", "400": "400%", "800": "800%", "1600": "1600%", "2400": "2400%", "3200": "3200%", "6400": "6400%" } }, "ColorSpace": { "enum": [ "Default", "RGB", "CMYK", "Gray" ], "type": "string", "description": "Set PDF color space.", "default": "Default", "x-ca-featured": false, "x-ca-label": "PDF color space", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Default": "Default", "RGB": "RGB", "CMYK": "CMYK", "Gray": "Gray" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Take full control of your PDF documents with our feature-rich API. Easily embed fonts, subset characters, set the PDF version, and adjust key metadata like title, subject, author, and more. Customize default page view settings, including page number and zoom, and choose the perfect ColorSpace for optimal presentation. Our PDF API gives you the flexibility to fine-tune every detail of your PDFs.\n", "x-ca-overview-markdown": "Take full control of your PDF documents with our feature-rich API. Easily `embed fonts`, `subset characters`, set the `PDF version`, and adjust key `metadata` like title, subject, author, and more. Customize default page view settings, including `page number` and `zoom`, and choose the perfect `ColorSpace` for optimal presentation. Our PDF API gives you the flexibility to fine-tune every detail of your PDFs.", "x-ca-meta-title": "PDF to PDF API – Advanced PDF Manipulation and Optimization", "x-ca-meta-description": "Enhance your PDF files with our PDF to PDF API. Easily embed fonts, subset characters, set PDF version, customize metadata, and choose your ColorSpace for superior document control.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf" ] }, "/convert/pdf/to/pdf-watermark": { "summary": "Overlay Watermark PDF API", "description": "Overlay PDFs with another PDF page as a watermark. Choose source page, scale, opacity, position, page ranges, links, and style.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pdf-watermark" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "OverlayFile" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OverlayFile": { "type": "string", "description": "Specifies the PDF file to use as overlay. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "Overlay PDF file", "x-ca-group": "Watermark", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "Style": { "enum": [ "stamp", "watermark" ], "type": "string", "description": "Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.", "default": "watermark", "x-ca-featured": true, "x-ca-label": "Watermark style", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "stamp": "Stamp", "watermark": "Watermark" } }, "OverlayPage": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Specifies the page to use as overlay from the OverlayFile file.", "default": 1, "x-ca-featured": false, "x-ca-label": "Overlay PDF page", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Scale": { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Specifies the watermark scale in percent.", "default": 100, "x-ca-featured": false, "x-ca-label": "Scale watermark", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "2000" } }, "Opacity": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Specifies watermark opacity level.", "default": 100, "x-ca-featured": false, "x-ca-label": "Opacity level", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "100" } }, "GoToLink": { "type": "string", "description": "Specifies the web address to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to web link", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "GoToPage": { "type": "string", "description": "Specifies the page number to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to page", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRotation": { "type": "boolean", "description": "Specifies whether the watermark should respect the PDF page rotation. When enabled, the watermark is rotated together with the page. When disabled, the watermark is placed ignoring page rotation.", "default": false, "x-ca-featured": false, "x-ca-label": "Use page rotation", "x-ca-group": "Watermark", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageBox": { "enum": [ "mediabox", "trimbox", "bleedbox", "cropbox" ], "type": "string", "description": "Specifies the PDF page box used as the reference area for applying the watermark.", "default": "mediabox", "x-ca-featured": false, "x-ca-label": "PageBox", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "mediabox": "MediaBox", "trimbox": "TrimBox", "bleedbox": "BleedBox", "cropbox": "CropBox" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Measurement unit for position and size parameters.", "default": "pt", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "OffsetX": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the X-axis. Positive values move the watermark to the right, while negative values move it to the left, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in X axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "OffsetY": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the Y-axis. Positive values move the watermark downward, while negative values move it upward, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in Y axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "HorizontalAlignment": { "enum": [ "left", "center", "right" ], "type": "string", "description": "Specifies the horizontal watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Horizontal watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "left": "Left", "center": "Center", "right": "Right" } }, "VerticalAlignment": { "enum": [ "top", "center", "bottom" ], "type": "string", "description": "Specifies the vertical watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Vertical watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "top": "Top", "center": "Center", "bottom": "Bottom" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Use a PDF page as an overlay watermark across target PDFs for branding and background graphics. Select the source PDF overlay file and page, control scale and opacity, and position the overlay on each page. Apply to specific pages or ranges, set a watermark style, and add interactive actions such as external links or go‑to page navigation. Respect page rotation and place the overlay precisely for consistent, professional results across batches and automated workflows.\n", "x-ca-overview-markdown": "Use a PDF page as an overlay watermark across target PDFs for branding and background graphics. Select the source PDF overlay file and page, control scale and opacity, and position the overlay on each page. Apply to specific pages or ranges, set a watermark style, and add interactive actions such as external links or go‑to page navigation. Respect page rotation and place the overlay precisely for consistent, professional results across batches and automated workflows.", "x-ca-meta-title": "Overlay Watermark PDF API – Use PDF page as watermark", "x-ca-meta-description": "Overlay PDFs via API using a PDF page as a watermark. Set source page, scale, opacity, position, page ranges, links, and style.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "watermark", "pdf", "featured" ] }, "/convert/pdf/to/pdfa": { "summary": "PDF to PDF/A API", "description": "Reliable PDF to PDF/A API for long-term archiving, VeraPDF certified, with batch processing and optional embedded e-invoice XML.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pdfa" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PdfaVersion": { "enum": [ "pdfA1a", "pdfA1b", "pdfA2a", "pdfA2b", "pdfA2u", "pdfA3a", "pdfA3b", "pdfA3u", "pdfA4", "pdfA4e", "pdfA4f" ], "type": "string", "description": "Set PDF/A version.", "default": "pdfA2b", "x-ca-featured": true, "x-ca-label": "PDF/A version", "x-ca-group": "PDF/A", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pdfA1a": "PDF/A-1a", "pdfA1b": "PDF/A-1b", "pdfA2a": "PDF/A-2a", "pdfA2b": "PDF/A-2b", "pdfA2u": "PDF/A-2u", "pdfA3a": "PDF/A-3a", "pdfA3b": "PDF/A-3b", "pdfA3u": "PDF/A-3u", "pdfA4": "PDF/A-4", "pdfA4e": "PDF/A-4e", "pdfA4f": "PDF/A-4f" } }, "InvoiceFormat": { "enum": [ "none", "facturX", "zugferd1", "zugferd2" ], "type": "string", "description": "Selects the e-invoice format to embed. Choosing any e-invoice format overrides the selected PDF/A version and outputs PDF/A-3. Requires a valid structured invoice XML.", "default": "none", "x-ca-featured": false, "x-ca-label": "Invoice data format", "x-ca-group": "Invoice", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "No e-invoice embedding", "facturX": "Factur-X XML", "zugferd1": "ZUGFeRD 1.0 XML", "zugferd2": "ZUGFeRD 2.0 XML" } }, "InvoiceFile": { "type": "string", "description": "Specifies the structured invoice XML (ZUGFeRD / Factur-X) to embed for hybrid-invoice compatibility. Required when `InvoiceFormat` is enabled.", "format": "binary", "x-ca-featured": false, "x-ca-label": "Invoice File", "x-ca-group": "Invoice", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "xml" ] }, "Linearize": { "type": "boolean", "description": "Linearize PDF file and optimize for fast Web View.", "default": false, "x-ca-featured": false, "x-ca-label": "Linearize", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Leverage our PDF to PDF/A API to convert your PDFs into the PDF/A format, tailored for archival and preservation needs.\nThis tool supports PDF/A ISO conformance levels, such as PDF/A-1a, PDF/A-1b, PDF/A-2a, PDF/A-2b, PDF/A-2u, PDF/A-3a, PDF/A-3b, PDF/A-3u, PDF/A-4, PDF/A-4e, and PDF/A-4f, ensuring your documents meet strict archival standards.\nE-Invoice ready. Optionally embed structured e-invoice XML in the output PDF/A. We support Factur-X 1.0 and ZUGFeRD 1.0/2.0 profiles, ideal for compliant archiving and exchange. Use with PDF/A-3 to include the XML payload alongside the visual PDF.\nIt's ideally suited for professionals and organizations looking for a dependable solution for document preservation, offering customizable options to fit various compliance and archival requirements. With our API, secure and long-term document storage becomes straightforward and efficient.\n", "x-ca-overview-markdown": "Leverage our PDF to PDF/A API to convert your PDFs into the PDF/A format, tailored for archival and preservation needs. \r\n\r\nThis tool supports PDF/A ISO conformance levels, such as **PDF/A-1a**, **PDF/A-1b**, **PDF/A-2a**, **PDF/A-2b**, **PDF/A-2u**, **PDF/A-3a**, **PDF/A-3b**, **PDF/A-3u**, **PDF/A-4**, **PDF/A-4e**, and **PDF/A-4f**, ensuring your documents meet strict archival standards. \r\n\r\nE-Invoice ready. Optionally embed structured e-invoice XML in the output PDF/A. We support **Factur-X 1.0** and **ZUGFeRD 1.0/2.0** profiles, ideal for compliant archiving and exchange. Use with **PDF/A-3** to include the XML payload alongside the visual PDF.\r\n\r\nIt's ideally suited for professionals and organizations looking for a dependable solution for document preservation, offering customizable options to fit various compliance and archival requirements. With our API, secure and long-term document storage becomes straightforward and efficient.", "x-ca-meta-title": "PDF to PDF/A Conversion API - Archive-Grade PDF Compliance", "x-ca-meta-description": "Convert PDFs to PDF/A via API. Pick conformance level (PDF/A-1/2/3), handle passwords, embed invoices (ZUGFeRD/Factur-X), and produce archive-ready files.", "x-ca-keywords": "pdf, pdfa, archive, compliance", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf", "pdfa", "featured" ] }, "/convert/pdf/to/pdfua": { "summary": "PDF to PDF/UA API", "description": "Convert PDF to PDF/UA with correct tagging, logical reading order, and structure for full assistive‑technology accessibility.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pdfua" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Linearize": { "type": "boolean", "description": "Linearize PDF file and optimize for fast Web View.", "default": false, "x-ca-featured": false, "x-ca-label": "Linearize", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Ensure full accessibility and compliance by converting your PDFs to the PDF/UA (ISO 14289-1) standard. Our API automatically applies essential accessibility features, including logical reading order, semantic tagging, accessible metadata, and alt-text support for images. PDF/UA output ensures compatibility with assistive technologies like screen readers and keyboard navigation tools, while also aligning with key accessibility guidelines such as WCAG. Deliver documents that are perceivable, operable, understandable, and robust for all users.\n", "x-ca-overview-markdown": "Ensure full accessibility and compliance by converting your PDFs to the PDF/UA (ISO 14289-1) standard. Our API automatically applies essential accessibility features, including logical reading order, semantic tagging, accessible metadata, and alt-text support for images. PDF/UA output ensures compatibility with assistive technologies like screen readers and keyboard navigation tools, while also aligning with key accessibility guidelines such as WCAG. Deliver documents that are perceivable, operable, understandable, and robust for all users.", "x-ca-meta-title": "PDF to PDF/UA API - WCAG Accessible PDF for Universal Access", "x-ca-meta-description": "Convert PDFs to accessible PDF/UA. Align with WCAG using proper tagging, reading order, structure, and assistive-technology support for universal access.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf", "pdfa" ] }, "/convert/pdf/to/png": { "summary": "PDF to PNG API", "description": "Convert PDF to PNG with page range, resolution/DPI control, width/height scaling, rotation, crop, and background.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-png" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Rotate": { "enum": [ "default", "none", "rotate90", "rotate180", "rotate270" ], "type": "string", "description": "Set PDF page rotation before converting to image.", "default": "default", "x-ca-featured": false, "x-ca-label": "Rotate page", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "none": "None", "rotate90": "Rotate 90", "rotate180": "Rotate 180", "rotate270": "Rotate 270" } }, "CropTo": { "enum": [ "BoundingBox", "TrimBox", "MediaBox", "ArtBox", "BleedBox" ], "type": "string", "description": "Defines the options for cropping the page.", "default": "BoundingBox", "x-ca-featured": false, "x-ca-label": "Crop to box", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "BoundingBox": "Bounding Box", "TrimBox": "Trim Box", "MediaBox": "Media Box", "ArtBox": "Art Box", "BleedBox": "Bleed Box" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "PNG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Scale.md.", "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "PNG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "PNG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "PNG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "FitToSize": { "type": "boolean", "description": "Gets or sets whether to scale the output image to fit within both ImageWidth and ImageHeight while maintaining the aspect ratio. When enabled, the image is sized to fit the more restrictive dimension. Requires both width and height to be specified.", "default": false, "x-ca-featured": false, "x-ca-label": "Fit to size", "x-ca-group": "PNG Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BackgroundColor": { "type": "string", "description": "Applies a color to the transparent PDF background, thereby setting the background color of the generated images. You can specify a color name (e.g. `white` or `black`), or use color codes such as RGB (e.g. `255,0,0`) or HEX (e.g. `#FF0000`). To preserve transparency, set the property value to `transparent`.", "x-ca-featured": false, "x-ca-label": "Background Color", "x-ca-group": "PNG Output", "x-ca-type": "Color", "x-ca-representation": "Default" }, "ColorSpace": { "enum": [ "rgb", "cmyk", "gray", "monochrome" ], "type": "string", "description": "Set image color space.", "default": "rgb", "x-ca-featured": false, "x-ca-label": "Image color space", "x-ca-group": "PNG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "rgb": "RGB", "cmyk": "CMYK", "gray": "Gray", "monochrome": "Monochrome" } }, "BitDepth": { "enum": [ "default", "1", "2", "4", "8", "16" ], "type": "string", "description": "Set the number of bits per color channel in the output image. Higher values improve color precision and gradient smoothness but increase file size.", "default": "default", "x-ca-featured": false, "x-ca-label": "Bit depth", "x-ca-group": "PNG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "1": "1 bit", "2": "2 bits", "4": "4 bits", "8": "8 bits", "16": "16 bits" } }, "CompressionLevel": { "maximum": 9, "minimum": 0, "type": "integer", "description": "Define the compression level (0–9). A higher value increases compression, reducing file size. For lossy formats (JPG), this decreases image quality; for lossless formats (PNG), it increases compression strength without affecting quality.", "x-ca-featured": false, "x-ca-label": "Compression level", "x-ca-group": "PNG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "9" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to PNG images, create hi-res PNGs, and thumbnail images from PDF. Adjust PNG image resolution, dimension, and quality.\n", "x-ca-overview-markdown": "Convert PDF documents to PNG images, create hi-res PNGs, and thumbnail images from PDF. Adjust PNG image resolution, dimension, and quality.", "x-ca-meta-title": "PDF to PNG Conversion API – Convert PDF to PNG Images", "x-ca-meta-description": "Convert PDF to PNG via API. Set page range, resolution, width/height, background color, rotation/crop, and handle passwords reliably.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "png", "x-ca-tags": [ "pdf", "image", "featured" ] }, "/convert/pdf/to/pptx": { "summary": "PDF to PPTX API", "description": "Convert PDFs to editable PPTX preserving layouts, text, tables, and images with password, page ranges, font embedding, and OCR.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-pptx" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "EmbedFonts": { "type": "boolean", "description": "Embed fonts to output document.", "default": false, "x-ca-featured": false, "x-ca-label": "Embed fonts", "x-ca-group": "PowerPoint", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TextRecoveryMode": { "enum": [ "auto", "always", "never" ], "type": "string", "description": "Specifies how text is recovered from PDFs that use non-standard encodings (NSE). When set to `auto`, the converter detects and recovers text only when needed; `always` forces NSE recovery for all text; and `never` disables it.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Text Recovery Mode", "x-ca-group": "PowerPoint", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "always": "Always", "never": "Never" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Transform PDF documents into editable PowerPoint (PPTX) while maintaining slide fidelity. Preserve layouts, fonts, text, images, tables, charts, and vector graphics so content is ready to refine. Handle protected files with password input and limit processing to specific page ranges to create targeted decks. Recover content from scanned PDFs by enabling OCR, selecting the engine and languages to maximize accuracy. Embed fonts for consistent rendering across devices, and optionally stamp pages when required. Built for automation and batch pipelines, the API produces predictable results suitable for reuse, review, and presentation workflows.\n", "x-ca-overview-markdown": "Transform PDF documents into editable PowerPoint (PPTX) while maintaining slide fidelity. Preserve layouts, fonts, text, images, tables, charts, and vector graphics so content is ready to refine. Handle protected files with password input and limit processing to specific page ranges to create targeted decks. Recover content from scanned PDFs by enabling OCR, selecting the engine and languages to maximize accuracy. Embed fonts for consistent rendering across devices, and optionally stamp pages when required. Built for automation and batch pipelines, the API produces predictable results suitable for reuse, review, and presentation workflows.", "x-ca-meta-title": "PDF to PPTX Conversion API – Convert PDF to PowerPoint", "x-ca-meta-description": "Convert PDFs to editable PPTX via API. Preserve layout, text, tables, charts, and images; handle passwords and ranges; enable OCR and embed fonts.", "x-ca-keywords": "pdf, pptx, powerpoint, office", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pptx", "x-ca-tags": [ "pdf", "extract", "presentation", "featured" ] }, "/convert/pdf/to/print": { "summary": "PDF Print Production API", "description": "Prepare print-ready PDFs with trim, bleed, marks, color spaces, output intents, ICC profiles, and image downsampling.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-print" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range to convert. The parameter understands digits and the keywords even, odd and last. Example: 1,2,5-last. Regardless of the range specified, a maximum of 100 pages will be processed per conversion.", "default": "1-last", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "TrimSize": { "enum": [ "default", "a2", "a3", "a4", "a5", "a6", "letter", "legal", "custom" ], "type": "string", "description": "Page size to enforce on every page. `Default` keeps each page’s current size; `Custom` activates `TrimWidth` / `TrimHeight`.", "default": "default", "x-ca-featured": false, "x-ca-label": "Trim size", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "letter": "Letter", "legal": "Legal", "custom": "Custom" } }, "TrimWidth": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.", "x-ca-featured": false, "x-ca-label": "Trim width", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "TrimHeight": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.", "x-ca-featured": false, "x-ca-label": "Trim height", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "BleedTop": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added above the Trim Box (top edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area at the top for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed top", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedRight": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added to the right of the Trim Box (right edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area on the right for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed right", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedBottom": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added below the bottom of the Trim Box (bottom edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area at the bottom for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed bottom", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedLeft": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added to the left of the Trim Box (left edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area on the left for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed left", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedMode": { "enum": [ "none", "mirror", "stretch" ], "type": "string", "description": "Defines how additional bleed content is generated when bleed is requested. Choose `Mirror` to mirror page content outward into the bleed area for a realistic full-bleed preview, `Stretch` to extend edge pixels into the bleed, or `None` to disable bleed fabrication.", "default": "none", "x-ca-featured": false, "x-ca-label": "Bleed mode", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "mirror": "Mirror", "stretch": "Stretch" } }, "TrimMarks": { "type": "boolean", "description": "Adds crop marks outside the Bleed Box.", "default": false, "x-ca-featured": false, "x-ca-label": "Trim marks", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RegistrationMarks": { "type": "boolean", "description": "Adds registration targets centred ≥3mm outside Bleed Box on each edge.", "default": false, "x-ca-featured": false, "x-ca-label": "Registration marks", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Slug": { "type": "string", "description": "Text placed on the bottom of the Media Box (e.g., printed file name, order number, customer information, etc.).", "x-ca-featured": false, "x-ca-label": "Slug", "x-ca-group": "Printing Marks", "x-ca-type": "String", "x-ca-representation": "Default" }, "TintBars": { "type": "boolean", "description": "Adds grayscale and color control bars at the top of the page, positioned outside the Trim Box.", "default": false, "x-ca-featured": false, "x-ca-label": "Tint bars", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ColorSpace": { "enum": [ "default", "rgb", "cmyk", "gray" ], "type": "string", "description": "Set PDF color space. The `Default` option leaves the color space as is.", "default": "default", "x-ca-featured": false, "x-ca-label": "Color space", "x-ca-group": "Color Management", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "cmyk": "CMYK", "gray": "Gray" } }, "OutputIntent": { "enum": [ "none", "fogra39", "fogra51", "gracol2013", "swop2013", "japancolor2011", "custom" ], "type": "string", "description": "Embeds ICC profile as PDF OutputIntent. Choosing `Custom` requires `OutputIntentIccFile` to be provided.", "default": "none", "x-ca-featured": false, "x-ca-label": "Output intent", "x-ca-group": "Color Management", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "fogra39": "FOGRA39 (ISO Coated v2)", "fogra51": "FOGRA51 (PSO Coated v3)", "gracol2013": "GRACoL 2013 (CGATS 21_CRPC6)", "swop2013": "SWOP 2013 (CGATS 21_CRPC5)", "japancolor2011": "Japan Color 2011 Coated", "custom": "Custom" } }, "OutputIntentIccFile": { "type": "string", "description": "Embeds ICC profile as PDF OutputIntent. Required when `OutputIntent` is set to `custom`.", "format": "binary", "x-ca-featured": false, "x-ca-label": "Output Intent Icc File", "x-ca-group": "Color Management", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "icc" ] }, "EmbedFonts": { "type": "boolean", "description": "Embed fonts in PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Embed fonts", "x-ca-group": "PDF Fonts", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SubsetFonts": { "type": "boolean", "description": "Include in the output PDF document only the font characters that are used in the original document.", "default": true, "x-ca-featured": false, "x-ca-label": "Subset fonts", "x-ca-group": "PDF Fonts", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "DownsampleImages": { "type": "boolean", "description": "Reduces images above resolution to save file size.", "default": false, "x-ca-featured": false, "x-ca-label": "Downsample images", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Resolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Target resolution (PPI) used for rasterization tasks such as bleed fabrication and image downsampling.", "default": 300, "x-ca-featured": false, "x-ca-label": "Resolution", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The PDF Print Production API prepares PDFs for professional printing with precise control over page geometry, color, and output compliance. Enforce standard or custom trim sizes using multiple measurement units, define bleed on all sides, and generate bleed content using mirror image or pixel repeat modes. Add production marks such as trim marks, registration marks, tint bars, and optional slug text for job identification. Manage color spaces including RGB, sRGB, CMYK, and Gray, and embed industry-standard PDF Output Intents such as FOGRA, GRACoL, SWOP, and Japan Color for print consistency. Custom ICC profiles are supported when required. Optimize output by downsampling images, setting target resolution, and selecting precise page ranges, making the tool ideal for automated, print-ready PDF workflows at scale.\n", "x-ca-overview-markdown": "The PDF Print Production API prepares PDFs for professional printing with precise control over page geometry, color, and output compliance. Enforce standard or custom trim sizes using multiple measurement units, define bleed on all sides, and generate bleed content using mirror image or pixel repeat modes. Add production marks such as trim marks, registration marks, tint bars, and optional slug text for job identification. Manage color spaces including RGB, sRGB, CMYK, and Gray, and embed industry-standard PDF Output Intents such as FOGRA, GRACoL, SWOP, and Japan Color for print consistency. Custom ICC profiles are supported when required. Optimize output by downsampling images, setting target resolution, and selecting precise page ranges, making the tool ideal for automated, print-ready PDF workflows at scale.", "x-ca-meta-title": "PDF Print Production API - Trim, Bleed & Print Marks", "x-ca-meta-description": "Convert PDFs to print production PDFs with trim and bleed, optional mirror or repeat bleed, crop and registration marks, tint bars, slug text, color space conversion, and image downsampling.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf" ] }, "/convert/pdf/to/protect": { "summary": "Protect PDF API", "description": "Secure PDF documents with 256-bit AES encryption, set owner and user passwords, and restrict printing or editing permissions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-protect" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "UserPassword": { "type": "string", "description": "Sets the user password (also known as a document open password) in the output PDF document. Users will be asked to enter this password before Acrobat Reader allows them to view the PDF document.", "x-ca-featured": true, "x-ca-label": "User Password", "x-ca-group": "Encryption", "x-ca-type": "String", "x-ca-representation": "Default" }, "EncryptionAlgorithm": { "enum": [ "Standard40Bit", "Standard128Bit", "Aes128Bit", "Aes256Bit" ], "type": "string", "description": "Sets the encryption algorithm.", "default": "Aes256Bit", "x-ca-featured": false, "x-ca-label": "Encryption algorithm", "x-ca-group": "Encryption", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Standard40Bit": "40-bit RC4 algorithm. Acrobat 3 (PDF 1.1) and above", "Standard128Bit": "128-bit RC4 algorithm. Acrobat 5 (PDF 1.4) and above", "Aes128Bit": "128-bit AES algorithm. Acrobat 7 (PDF 1.6) and above", "Aes256Bit": "256-bit AES algorithm. PDF 2.0" } }, "EncryptMeta": { "type": "boolean", "description": "Encrypt metadata of PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Encrypt Meta", "x-ca-group": "Encryption", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OwnerPassword": { "type": "string", "description": "Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don’t need a password to open the document. They do need a password to change the restrictions the owner set.", "x-ca-featured": true, "x-ca-label": "Owner Password", "x-ca-group": "Document Permissions", "x-ca-type": "String", "x-ca-representation": "Default" }, "RespectOwnerPassword": { "type": "boolean", "description": "Enable the property if you want to respect the document's owner password and permissions. If disabled - the old owner's password and permissions will be removed by default. Setting this property requires you to enter the correct owner's password into the Password property for protected documents.", "default": false, "x-ca-featured": false, "x-ca-label": "Respect owner password", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PreservePermissions": { "type": "boolean", "description": "Enable the property if you want to keep the document permissions unchanged. It requires you to specify the OwnerPassword. If enabled, the document permission properties will be ignored.", "default": false, "x-ca-featured": false, "x-ca-label": "Preserve document permissions", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AllowEverything": { "type": "boolean", "description": "Enable or disable all permissions. The specific permissions listed below overrides this property.", "default": false, "x-ca-featured": false, "x-ca-label": "Allow everything", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AssembleDocument": { "type": "boolean", "description": "Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.", "default": false, "x-ca-featured": false, "x-ca-label": "Assemble document", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CopyContents": { "type": "boolean", "description": "Enable or disable copy or extract text and graphics from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Copy contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ModifyContents": { "type": "boolean", "description": "Enable or disable changing the contents of the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Modify contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExtractContents": { "type": "boolean", "description": "Enable or disable extract text and graphics.", "default": false, "x-ca-featured": false, "x-ca-label": "Extract contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ModifyAnnotations": { "type": "boolean", "description": "Enable or disable adding or modifying text annotations and fill in interactive form fields.", "default": false, "x-ca-featured": false, "x-ca-label": "Modify annotations", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillFormFields": { "type": "boolean", "description": "Enable or disable fill-in existing interactive form fields, including signature fields.", "default": false, "x-ca-featured": false, "x-ca-label": "Fill form fields", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PrintDocument": { "type": "boolean", "description": "Enable or disable document printing.", "default": false, "x-ca-featured": false, "x-ca-label": "Print document", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PrintFaithfulCopy": { "type": "boolean", "description": "Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.", "default": false, "x-ca-featured": false, "x-ca-label": "Print faithful copy", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Protect PDF files with strong encryption and granular permissions. Choose AES‑256 to secure content, set user and owner passwords, and decide what recipients can do: print, copy, modify contents or annotations, fill forms, assemble, or allow everything. Preserve metadata or encrypt it as needed, and respect existing owner passwords when appropriate. Ideal for automated workflows that harden documents for sharing, compliance, and long‑term storage while keeping layout and fidelity intact.\n", "x-ca-overview-markdown": "Protect PDF files with strong encryption and granular permissions. Choose AES‑256 to secure content, set user and owner passwords, and decide what recipients can do: print, copy, modify contents or annotations, fill forms, assemble, or allow everything. Preserve metadata or encrypt it as needed, and respect existing owner passwords when appropriate. Ideal for automated workflows that harden documents for sharing, compliance, and long‑term storage while keeping layout and fidelity intact.", "x-ca-meta-title": "Protect PDF API – Encrypt and set permissions for PDFs", "x-ca-meta-description": "Encrypt PDFs with AES‑256 via API. Set user/owner passwords and fine‑grained permissions for printing, editing, copying, forms, and more.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "security", "pdf" ] }, "/convert/pdf/to/rasterize": { "summary": "Rasterize PDF API", "description": "Convert vector-based PDF pages into high-resolution raster images within a PDF container to prevent editing and extraction.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-rasterize" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Resolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Defines the resolution for rasterized PDF pages, measured in dots per inch (DPI). Higher DPI values produce better image quality but result in larger file sizes. This property enables balancing the trade-off between image clarity and file size.", "default": 300, "x-ca-featured": false, "x-ca-label": "Document resolution", "x-ca-group": "Rasterization", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The PDF Rasterize API transforms vector-based PDF into single-layer, image-like PDF, ensuring consistent rendering across various platforms and enhancing compatibility, especially with complex graphics. Rasterizing protects document content by making text and vector elements uneditable, making it ideal for creating read-only documents.\n", "x-ca-overview-markdown": "The PDF Rasterize API transforms vector-based PDF into single-layer, image-like PDF, ensuring consistent rendering across various platforms and enhancing compatibility, especially with complex graphics. Rasterizing protects document content by making text and vector elements uneditable, making it ideal for creating read-only documents.", "x-ca-meta-title": "Rasterize PDF API - Convert Vector PDF into Raster PDF", "x-ca-meta-description": "The PDF Rasterize API converts vector-based PDFs into single-layer, image-like rasterized PDFs, ensuring consistent rendering and enhanced compatibility across platforms.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "optimize", "pdf" ] }, "/convert/pdf/to/redact": { "summary": "Redact PDF API", "description": "AI-powered redaction of PII, PHI, financial, legal, and confidential data with custom presets and color/thickness options.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-redact" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Preset": { "enum": [ "auto", "gdpr", "hipaa", "ferpa", "foia", "glba", "ccpa", "manual" ], "type": "string", "description": "The Preset parameter determines the type of sensitive data the AI will detect and redact from the document. It complements the `RedactionData`, enabling you to refine or expand the redaction criteria. Select `manual` to use your customized redaction options exclusively.\r\n\r\nChoose a preset to define the type of sensitive data the AI will detect and redact from the document:\r\n\r\n- **Auto** - Automatically detects and redacts sensitive data across all categories, including PII, financial, healthcare, legal, and confidential information. Best for general redaction when the document type is unknown or contains mixed data.\r\n\r\n- **GDPR** - Redacts personal data as required by GDPR, including names, emails, IP addresses, phone numbers, and national IDs.\r\n\r\n- **HIPAA** - Ensures compliance with HIPAA by redacting protected health information (PHI) such as patient names, medical record numbers, diagnoses, and prescription details.\r\n\r\n- **FERPA** - Redacts personally identifiable student information to comply with FERPA, including student names, school records, and educational identifiers.\r\n\r\n- **FOIA** - Prevents the exposure of sensitive personal or national security data in documents released under FOIA. This includes classified content, addresses, and government IDs.\r\n\r\n- **GLBA** - Complies with GLBA by redacting financial data such as bank account numbers, credit card details, loan records, and investment information.\r\n\r\n- **CCPA** -Meets CCPA requirements by removing consumer personal data such as purchase history, geolocation, contact details, and online identifiers upon request.\r\n\r\n- **Manual** - Disables automatic AI detection preset. Only the manually set parameters will be used to determine what should be redacted. Ideal for users who want full control over redaction without AI-based automation.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Detect preset", "x-ca-group": "Automatic AI Redaction", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Detect All Sensitive Data", "gdpr": "Personally Identifiable Information", "hipaa": "Patient Health Information", "ferpa": "Student Identification Data", "foia": "Personal or National Security Data", "glba": "Sensitive Financial Data", "ccpa": "Personal Consumer Data", "manual": "Custom Redaction Only" } }, "ContextSize": { "enum": [ "balanced", "page" ], "type": "string", "description": "Defines how the AI engine processes the document in terms of context.\r\n\r\nWhen the `ContextSize` parameter is set to `Page`, each page is processed independently, without context from other pages. This mode is useful when a document contains structured or repetitive data (such as tables with rows of values), or when a high volume of detections is expected. By limiting context to a single page, the AI avoids confusion from unrelated content and ensures accuracy per page.\r\n\r\nWhen the `ContextSize` parameter is set to `Balanced`, the AI maintains context across multiple pages while still optimizing processing efficiency. This mode is recommended for large or multi-page documents where relationships between sections matter, and it also provides improved performance for large documents.", "default": "balanced", "x-ca-featured": false, "x-ca-label": "Context Size", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "balanced": "Balanced", "page": "Page" } }, "RedactionColor": { "type": "string", "description": "Specifies the color used to mask redacted text, accepting formats such as Hexadecimal (e.g., `#FFFFFF` for white or `#FF5733` for orange), RGB with an optional alpha channel (e.g., `255,255,255` for white or `255,255,255`), and named colors (e.g., `white`, `red`, `blue`).", "x-ca-featured": false, "x-ca-label": "Redaction Color", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Color", "x-ca-representation": "Default" }, "RedactionThickness": { "maximum": 2, "minimum": 0.5, "type": "number", "description": "The RedactionThickness property controls the height of the redaction stroke line relative to the original line height.\r\n\r\n- A value of 1 means the stroke height matches the original line height.\r\n- Values less than 1 (e.g., 0.5) reduce the stroke height.\r\n- Values greater than 1 (e.g., 1.5 or 2) increase the stroke height.", "default": 1, "x-ca-featured": false, "x-ca-label": "Redaction Thickness", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.5", "to": "2" } }, "PII": { "type": "boolean", "description": "**Personally Identifiable Information (PII)** - Detects and redacts common personal identifiers, including names, email addresses, phone numbers, birthdates, and home addresses.", "default": false, "x-ca-featured": false, "x-ca-label": "Personally Identifiable Information (PII)", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PHI": { "type": "boolean", "description": "**Patient Health Information (PHI)** - Detects health-related information such as patient names, medical records, insurance details, and prescription data.", "default": false, "x-ca-featured": false, "x-ca-label": "Patient Health Information (PHI)", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Financial": { "type": "boolean", "description": "**Financial Data** - Focuses on financial records, including credit card numbers, bank account numbers, financial transaction details, etc.", "default": false, "x-ca-featured": false, "x-ca-label": "Financial Data", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Legal": { "type": "boolean", "description": "**Legal and Contractual Data** - Detects legal and contractual terms, including case numbers, legal clauses, signatures, and confidential agreements.", "default": false, "x-ca-featured": false, "x-ca-label": "Legal and Contractual Data", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Confidential": { "type": "boolean", "description": "**Legal and Contractual Data** - Detects proprietary business information, contracts and agreements, internal communications, trade secrets, intellectual property details, and sensitive corporate data.", "default": false, "x-ca-featured": false, "x-ca-label": "Confidential", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RedactionData": { "type": "string", "description": "A JSON array defining specific values for redaction. Supports three methods:\r\n\r\n- **Text** – Exact text to be redacted.\r\n- **Regex** – *Escaped* regular expression patterns for flexible text matching.\r\n- **Detect** – AI-based detection using a description of what to find.\r\n\r\nIf `RedactionData` is passed, it forces: `Preset` is set to `manual`, and all built-in detection options (such as `PII`, `PHI`, `Financial`, `Legal`, `Confidential`) are disabled. In this mode, only the values defined in RedactionData are applied.\r\n\r\n#### Example JSON\r\n\r\n```json\r\n[\r\n {\r\n \"Text\": \"john@domain.com\"\r\n },\r\n {\r\n \"Detect\": \"Bank account number\"\r\n },\r\n {\r\n \"Regex\": \"\\\\b100\\\\s*(€|\\\\$)\\\\b\"\r\n }\r\n]\r\n```", "x-ca-featured": false, "x-ca-label": "Text to Mask JSON Payload", "x-ca-group": "Custom Redaction Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "MinimumConfidence": { "maximum": 0.99, "minimum": 0.01, "type": "number", "description": "Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.", "default": 0.5, "x-ca-featured": false, "x-ca-label": "Minimum confidence", "x-ca-group": "Automatic AI Redaction", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.01", "to": "0.99" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Automatically detect and black out information in PDF document. Whether you need to secure business documents or protect personal information, our tool provides reliable, efficient, and user-friendly redaction solutions. Start safeguarding your PDFs today with our trusted Data Redact API.\n", "x-ca-overview-markdown": "Automatically detect and black out information in PDF document. Whether you need to secure business documents or protect personal information, our tool provides reliable, efficient, and user-friendly redaction solutions. Start safeguarding your PDFs today with our trusted Data Redact API.", "x-ca-meta-title": "Redact Sensitive PDF Data with AI - Redact PDF API", "x-ca-meta-description": "Redact sensitive data from PDF documents easily using AI or JSON. Redact PDFs to protect confidential information with our intelligent PDF Redact API.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "ai", "pdf", "security", "modify" ] }, "/convert/pdf/to/remove-watermark": { "summary": "Remove Watermark PDF API", "description": "Remove text watermarks like draft notices, confidentiality stamps, and evaluation marks from PDF documents using AI.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-remove-watermark" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "AiDetection": { "type": "boolean", "description": "Use AI to detect and remove text-based watermarks. When disabled, only structural watermarks embedded in the PDF are removed.", "default": true, "x-ca-featured": false, "x-ca-label": "AI detection", "x-ca-group": "AI Detection Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "WatermarkHint": { "type": "string", "description": "Optional description of the watermark to help the AI detect and remove it more accurately. Useful when the watermark contains specific text, logos, or other identifiable characteristics.", "x-ca-featured": false, "x-ca-label": "Watermark hint", "x-ca-group": "AI Detection Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Automatically remove text watermarks from PDF documents. AI detects repeated overlay text across pages - status stamps, evaluation marks, ownership notices, and similar text annotations - and removes them cleanly without affecting surrounding content. Only the detected text watermark is removed; other content remains unchanged. Supports watermarks in any language, with an optional hint for unusual cases.\n", "x-ca-overview-markdown": "Automatically remove text watermarks from PDF documents. AI detects repeated overlay text across pages - status stamps, evaluation marks, ownership notices, and similar text annotations - and removes them cleanly without affecting surrounding content. Only the detected text watermark is removed; other content remains unchanged. Supports watermarks in any language, with an optional hint for unusual cases.", "x-ca-meta-title": "Remove Watermark PDF API - AI PDF Watermark Remover", "x-ca-meta-description": "Remove text watermarks from PDFs using AI. Detects DRAFT, CONFIDENTIAL, evaluation stamps, and ownership overlays, then removes them cleanly without redaction boxes.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "ai", "pdf", "watermark", "modify" ] }, "/convert/pdf/to/repair": { "summary": "Repair PDF API", "description": "Analyze and repair corrupt or damaged PDF files to recover content, fixing structural errors and restoring document usability.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-repair" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "FixFontEncoding": { "type": "boolean", "description": "Repairs broken text extraction in PDFs where copied or extracted text appears as garbled or unreadable characters, even though the document displays correctly on screen. Fixes missing or invalid Unicode mappings in embedded fonts.", "default": false, "x-ca-featured": false, "x-ca-label": "Fix font encoding", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "PDF Repair API is designed to restore corrupt and damaged PDF files efficiently. The API analyzes and repairs PDF documents, recovering them either partially or entirely based on the damage extent.\n", "x-ca-overview-markdown": "PDF Repair API is designed to restore corrupt and damaged PDF files efficiently. The API analyzes and repairs PDF documents, recovering them either partially or entirely based on the damage extent.", "x-ca-meta-title": "Repair PDF API - Repair Corrupt and Damaged PDF Files", "x-ca-meta-description": "Fix corrupt PDFs with ConvertAPI. Our API can recover your PDF partially or entirely, depending on the extent of the damage.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "optimize", "pdf" ] }, "/convert/pdf/to/resize": { "summary": "Resize PDF API", "description": "Resize PDF pages to standard formats like A4 or custom dimensions, adjusting page orientation for print or digital consistency.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-resize" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set page range to convert. The parameter understands digits and the keywords even, odd and last. Example: 1,2,5-last.", "default": "1-last", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Set page orientation.", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "custom", "a2", "a3", "a4", "a5", "a6", "letter", "legal" ], "type": "string", "description": "The property scales each page to fit a given page size.", "default": "a4", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "custom": "Custom", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "letter": "Letter", "legal": "Legal" } }, "PageHeight": { "maximum": 30000, "minimum": 1, "type": "number", "description": "Custom page height in the selected measurement unit. Enabled when `PageSize` is set to `Custom`.", "default": 10, "x-ca-featured": false, "x-ca-label": "Page height", "x-ca-group": "PDF Output", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "30000" } }, "PageWidth": { "maximum": 30000, "minimum": 1, "type": "number", "description": "Custom page width in the selected measurement unit. Enabled when `PageSize` is set to `Custom`.", "default": 10, "x-ca-featured": false, "x-ca-label": "Page width", "x-ca-group": "PDF Output", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "30000" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Specifies measurement unit to use for the page height and page width properties.", "default": "in", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The Resize PDF pages API by ConvertAPI allows you to adjust PDF page size, orientation for selected pages. Choose from standard formats like A4 or Letter, or define custom width and height with units in points, millimeters, centimeters, or inches. Ideal for preparing files for print, merging different page sizes, or optimizing PDFs for web and mobile viewing.\n", "x-ca-overview-markdown": "The Resize PDF pages API by ConvertAPI allows you to adjust PDF page size, orientation for selected pages. Choose from standard formats like A4 or Letter, or define custom width and height with units in points, millimeters, centimeters, or inches. Ideal for preparing files for print, merging different page sizes, or optimizing PDFs for web and mobile viewing.", "x-ca-meta-title": "Resize PDF API - Custom dimensions, Page Size & Orientation", "x-ca-meta-description": "Resize PDF pages to A4, Letter, or custom width/height. Choose units (points, millimeters, centimeters, inches) and set portrait or landscape.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf" ] }, "/convert/pdf/to/rotate": { "summary": "Rotate PDF API", "description": "Rotate PDF pages by angles or auto-correct orientation with page ranges, password support, and batch processing capabilities.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-rotate" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range to convert. The parameter understands digits and the keywords even, odd and last. Example: 1,2,5-last.", "default": "1-last", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "AutoRotate": { "type": "boolean", "description": "Automatic page orientation detection.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Rotate", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Angle": { "enum": [ "0", "90", "180", "270" ], "type": "string", "description": "Rotates page(s) by selected degree.", "default": "90", "x-ca-featured": false, "x-ca-label": "Rotation Angle", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "0 degree (normal)", "90": "90 degree", "180": "180 degree", "270": "270 degree" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Rotate pages in PDF documents with precise control over angle and scope. Specify explicit rotation angles and whether to rotate all pages or only pages in a provided range (for example, 1,3-5,10). Enable auto‑rotate to detect and correct mis‑oriented scans automatically, and open password‑protected files when required. Ideal for ingestion and cleanup pipelines that normalize page orientation before OCR, extraction, sharing, or archival, with predictable results across batches.\n", "x-ca-overview-markdown": "Rotate pages in PDF documents with precise control over angle and scope. Specify explicit rotation angles and whether to rotate all pages or only pages in a provided range (for example, 1,3-5,10). Enable auto‑rotate to detect and correct mis‑oriented scans automatically, and open password‑protected files when required. Ideal for ingestion and cleanup pipelines that normalize page orientation before OCR, extraction, sharing, or archival, with predictable results across batches.", "x-ca-meta-title": "Rotate PDF API – Rotate, auto‑correct, set angle for PDF pages", "x-ca-meta-description": "Rotate PDF pages via API. Set angles or auto‑rotate, apply to all or selected ranges, and process password‑protected files consistently.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf" ] }, "/convert/pdf/to/rtf": { "summary": "PDF to RTF API", "description": "Convert PDFs to editable RTF preserving text, formatting, tables, and images with password, page ranges, layout mode, and OCR.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-rtf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Layout": { "enum": [ "flowing", "continuous", "exact" ], "type": "string", "description": "Controls how the original PDF page layout is reconstructed in the output: choose `flowing` to produce editable flowing text, `continuous` to preserve the layout using continuous text frames, or `exact` to reproduce the page pixel-perfectly using text boxes.", "default": "flowing", "x-ca-featured": false, "x-ca-label": "Layout", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "flowing": "Flowing", "continuous": "Continuous", "exact": "Exact" } }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "Annotations": { "enum": [ "textBox", "comment", "none" ], "type": "string", "description": "Set how PDF annotations are handled in the DOCX output: choose `textBox` to place each annotation as an editable text box near its anchor, `comment` to convert annotations into Word comments attached to the relevant text, or `none` to omit all annotations from the result.", "default": "textBox", "x-ca-featured": false, "x-ca-label": "Annotations", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "textBox": "TextBox", "comment": "Comment", "none": "None" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to Rich Text Format (RTF) for editing in popular word processors. Preserve text flow and basic formatting, tables, images, and paragraph structure so content remains easy to revise and reuse. Limit processing to specific page ranges, open password-protected files, and choose a layout reconstruction mode: Flowing, Continuous, or Exact to balance editability against visual fidelity. Recover content from scanned PDFs by activating OCR, selecting the engine and languages to maximize recognition quality. Designed for automation and batch workflows, the API produces predictable, clean RTF output for search, redaction, and downstream editing.\n", "x-ca-overview-markdown": "Convert PDF documents to Rich Text Format (RTF) for editing in popular word processors. Preserve text flow and basic formatting, tables, images, and paragraph structure so content remains easy to revise and reuse. Limit processing to specific page ranges, open password-protected files, and choose a layout reconstruction mode: Flowing, Continuous, or Exact to balance editability against visual fidelity. Recover content from scanned PDFs by activating OCR, selecting the engine and languages to maximize recognition quality. Designed for automation and batch workflows, the API produces predictable, clean RTF output for search, redaction, and downstream editing.", "x-ca-meta-title": "PDF to RTF Conversion API – Convert PDF to RTF File", "x-ca-meta-description": "Convert PDFs to RTF via API. Preserve text, formatting, tables, and images. Handle passwords and ranges. Choose layout reconstruction mode and OCR for scans.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "rtf", "x-ca-tags": [ "pdf", "extract", "document" ] }, "/convert/pdf/to/split": { "summary": "Split PDF API", "description": "Split large PDF files into individual pages or specific ranges based on patterns, bookmarks, or text to organize your documents.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-split" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "SplitByPattern": { "type": "string", "description": "A comma-separated sequence of positive integers defining the size of each split segment. The PDF is divided into consecutive chunks whose page counts follow the given pattern, repeating it until all pages are consumed. For a 10-page PDF with `SplitByPattern = 3,2`, the output is four documents containing pages `[1-3]`, `[4-5]`, `[6-8]`, and `[9-10]` (pattern repeats: 3,2,3,2). The default `1` splits the PDF into single pages. This parameter is ignored when `SplitByRange`, `SplitByTextPattern`, `SplitByBookmark`, or `ExtractPages` is set.\r\n", "default": "1", "x-ca-featured": true, "x-ca-label": "Split by pattern", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "SplitByRange": { "type": "string", "description": "Specify exactly which pages to extract by listing single pages or inclusive ranges. The API emits one PDF per entry, in the order given. For a 10-page file with `SplitByRange = 1-3,5,7-9`, you receive three PDFs containing pages `[1-3]`, `[5]`, and `[7-9]`.\r\n", "x-ca-featured": true, "x-ca-label": "Split by range", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "SplitByTextPattern": { "type": "string", "description": "Splits the PDF into separate output files by starting a new document at each page whose text matches the specified regular expression. With `SplitByTextPattern = Chapter\\s+\\d+`, the PDF is split at every page where \"Chapter 1\", \"Chapter 2\", etc. appear. If \"Chapter 1\" is on page 1, \"Chapter 2\" on page 10, and \"Chapter 3\" on page 20 of a 25-page PDF, you receive three files containing pages `[1-9]`, `[10-19]`, and `[20-25]`. If the first match is not on page 1, the pages before it form the first output file.\r\n", "x-ca-featured": true, "x-ca-label": "Split by text pattern", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default" }, "SplitByBookmark": { "type": "boolean", "description": "Automatically splits a source PDF into individual documents, creating a new file at every bookmarked page. When nested bookmarks are present, splitting occurs at the deepest (child) level, and each output file is named to reflect the full bookmark hierarchy - for example: `ParentBookmark-ChildBookmark.pdf`. When the source PDF has no bookmarks, the original document is returned unchanged as `no-bookmarks.pdf`.", "default": false, "x-ca-featured": true, "x-ca-label": "Split by bookmark", "x-ca-group": "Split", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExtractPages": { "type": "string", "description": "A comma-separated list of single pages or inclusive ranges to extract from the source PDF. Ranges are expanded page by page, and each extracted page is returned as a separate single-page PDF. For example, `ExtractPages = 1,3-5,7` yields five PDFs containing pages `[1]`, `[3]`, `[4]`, `[5]`, and `[7]`. Set `MergeOutput = true` to combine the extracted pages into a single document.\r\n", "x-ca-featured": true, "x-ca-label": "Extract pages", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "MergeOutput": { "type": "boolean", "description": "When set to `true`, all files produced by the split, regardless of the split method used, are merged into a single PDF named `merged.pdf`. By default (`false`) the API returns each split part as a separate PDF.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Merge output", "x-ca-group": "Merge", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "PDF Split API offers a powerful solution for dividing documents with precision, enabling developers to split large PDF files into individual pages or custom page groups based on specific requirements. This customizable REST API seamlessly integrates into your workflow through simple API calls, supported by comprehensive SDKs and auto-generated code snippets that minimize development time. Built on secure cloud infrastructure with ISO 27001, HIPAA, SOC 2, and GDPR compliance, our PDF Splitter ensures your sensitive documents remain protected while delivering consistent performance.\n", "x-ca-overview-markdown": "PDF Split API offers a powerful solution for dividing documents with precision, enabling developers to split large PDF files into individual pages or custom page groups based on specific requirements. This customizable REST API seamlessly integrates into your workflow through simple API calls, supported by comprehensive SDKs and auto-generated code snippets that minimize development time. Built on secure cloud infrastructure with ISO 27001, HIPAA, SOC 2, and GDPR compliance, our PDF Splitter ensures your sensitive documents remain protected while delivering consistent performance.", "x-ca-meta-title": "Split PDF API - Split PDF documents into individual pages", "x-ca-meta-description": "Break PDFs into individual pages or custom chunks with ConvertAPI’s Split PDF API featuring regex patterns, text and range splitting.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "modify", "pdf", "featured" ] }, "/convert/pdf/to/svg": { "summary": "PDF to SVG API", "description": "Render PDF pages to scalable SVG vectors with password support, page range, resolution, anti-aliasing, and rotation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-svg" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleProportions": { "type": "boolean", "description": "If set to true, the barcode will be generated using recommended proportions based on the larger dimension.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale Proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageAntialiasing": { "maximum": 8, "minimum": 0, "type": "integer", "description": "Control the use of text and graphics subsample antialiasing. The subsampling box size should be 8 bits for optimum text antialiasing, but smaller values can be used for faster rendering.", "default": 8, "x-ca-featured": false, "x-ca-label": "Image antialiasing", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "8" } }, "Rotate": { "maximum": 360, "minimum": -360, "type": "integer", "description": "Rotate image by angle.", "x-ca-featured": false, "x-ca-label": "Rotate image", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "-360", "to": "360" } }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "Svg Output", "x-ca-type": "Color", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to clean SVG graphics suitable for web and app workflows. Handle password‑protected files, limit processing to a specific page range, and rotate pages to correct orientation. Control output using image resolution (DPI), scale proportions with explicit width/height, and apply anti‑aliasing for crisp rendering. Map a specific color to transparency to match UI backgrounds or downstream tools and keep results predictable across batches. Ideal for embedding diagrams, pages, and illustrations as scalable vector graphics with consistent characteristics.\n", "x-ca-overview-markdown": "Convert PDF documents to clean SVG graphics suitable for web and app workflows. Handle password‑protected files, limit processing to a specific page range, and rotate pages to correct orientation. Control output using image resolution (DPI), scale proportions with explicit width/height, and apply anti‑aliasing for crisp rendering. Map a specific color to transparency to match UI backgrounds or downstream tools and keep results predictable across batches. Ideal for embedding diagrams, pages, and illustrations as scalable vector graphics with consistent characteristics.", "x-ca-meta-title": "PDF to SVG Conversion API – Convert PDF to SVG Images", "x-ca-meta-description": "Convert PDF to SVG via API. Set page range, resolution, width/height, anti‑aliasing, rotation, and map a color to transparency; handle passwords.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "svg", "x-ca-tags": [ "pdf", "image", "featured" ] }, "/convert/pdf/to/text-watermark": { "summary": "Text Watermark PDF API", "description": "Apply text watermarks to PDF pages with control of font, size, color, stroke, opacity, rotation, position, links, and page ranges.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-text-watermark" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Text" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "Text": { "type": "string", "description": "Specifies the text to use as watermark. The list of supported variables: \r\n\r\n* ```%PAGE%``` - current page number\r\n* ```%PAGES%``` - total number of pages\r\n* ```%FILENAME%``` - name of the file\r\n* ```%WEEKDAY%``` - full weekday name\r\n* ```%WEEKDAY_SHORT%``` - abbreviated weekday name\r\n* ```%MONTH%``` - month number (1-12)\r\n* ```%MONTHNAME%``` - full month name\r\n* ```%MONTHNAME_SHORT%``` - abbreviated month name \r\n* ```%YEAR%``` - year with century (YYYY)\r\n* ```%YEAR_SHORT%``` - year without century (YY)\r\n* ```%DAY%``` - day of month\r\n* ```%DAY_YEAR%``` - day of the year (1 -366)\r\n* ```%HOUR%``` - hour (01- 12)\r\n* ```%HOURS%``` - hour (00-23)\r\n* ```%MINUTES%``` - minutes (00-59)\r\n* ```%SECONDS%``` - seconds (00-59)\r\n* ```%AMPM%``` - AM PM\r\n* ```%DATE%``` - local date representation\r\n* ```%TIME%``` - local time representation\r\n* ```%DATETIME%``` - local date and time \r\n* ```%AUTHOR%``` - document Author\r\n* ```%TITLE%``` - document Title\r\n* ```%SUBJECT%``` - document Subject\r\n* ```%KEYWORDS%``` - document Keywords\r\n* ```%N%``` - new line", "x-ca-featured": true, "x-ca-label": "Watermark text", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "Style": { "enum": [ "stamp", "watermark" ], "type": "string", "description": "Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.", "default": "stamp", "x-ca-featured": true, "x-ca-label": "Watermark style", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "stamp": "Stamp", "watermark": "Watermark" } }, "FontSize": { "maximum": 200, "minimum": 1, "type": "integer", "description": "Specifies the watermark font size.", "default": 40, "x-ca-featured": false, "x-ca-label": "Watermark font size", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "TextRenderingMode": { "enum": [ "filltext", "stroketext", "fillstroke", "invisible" ], "type": "string", "description": "Specifies the text rendering mode.", "default": "fillstroke", "x-ca-featured": false, "x-ca-label": "Text rendering mode", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "filltext": "Fill text without stroke", "stroketext": "Stroke text without fill", "fillstroke": "Fill and stroke", "invisible": "Invisible" } }, "FontColor": { "type": "string", "description": "Specifies the watermark font color.", "x-ca-featured": false, "x-ca-label": "Watermark font color", "x-ca-group": "Watermark", "x-ca-type": "Color", "x-ca-representation": "Default" }, "StrokeColor": { "type": "string", "description": "Specifies font stroke color.", "x-ca-featured": false, "x-ca-label": "Stroke color", "x-ca-group": "Watermark", "x-ca-type": "Color", "x-ca-representation": "Default" }, "StrokeWidth": { "maximum": 200, "minimum": 0, "type": "integer", "description": "Specifies the stroke width.", "default": 1, "x-ca-featured": false, "x-ca-label": "Stroke width", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "FontName": { "enum": [ "arial", "bahnschrift", "calibri", "cambria", "consolas", "constantia", "courierNew", "georgia", "tahoma", "timesNewRoman", "verdana" ], "type": "string", "description": "Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list.", "default": "arial", "x-ca-featured": false, "x-ca-label": "Watermark font name", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "arial": "Arial", "bahnschrift": "Bahnschrift", "calibri": "Calibri", "cambria": "Cambria", "consolas": "Consolas", "constantia": "Constantia", "courierNew": "Courier New", "georgia": "Georgia", "tahoma": "Tahoma", "timesNewRoman": "Times New Roman", "verdana": "Verdana" } }, "Rotate": { "maximum": 360, "minimum": 0, "type": "integer", "description": "Specifies the watermark rotation angle in degrees.", "default": 0, "x-ca-featured": false, "x-ca-label": "Rotate watermark", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "360" } }, "Opacity": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Specifies watermark opacity level.", "default": 100, "x-ca-featured": false, "x-ca-label": "Opacity level", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "100" } }, "GoToLink": { "type": "string", "description": "Specifies the web address to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to web link", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "GoToPage": { "type": "string", "description": "Specifies the page number to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to page", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageBox": { "enum": [ "mediabox", "trimbox", "bleedbox", "cropbox" ], "type": "string", "description": "Specifies the PDF page box used as the reference area for applying the watermark.", "default": "mediabox", "x-ca-featured": false, "x-ca-label": "PageBox", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "mediabox": "MediaBox", "trimbox": "TrimBox", "bleedbox": "BleedBox", "cropbox": "CropBox" } }, "HorizontalAlignment": { "enum": [ "left", "center", "right" ], "type": "string", "description": "Specifies the horizontal watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Horizontal watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "left": "Left", "center": "Center", "right": "Right" } }, "VerticalAlignment": { "enum": [ "top", "center", "bottom" ], "type": "string", "description": "Specifies the vertical watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Vertical watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "top": "Top", "center": "Center", "bottom": "Bottom" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Measurement unit for position and size parameters.", "default": "pt", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "OffsetX": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the X-axis. Positive values move the watermark to the right, while negative values move it to the left, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in X axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "OffsetY": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the Y-axis. Positive values move the watermark downward, while negative values move it upward, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in Y axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "Width": { "maximum": 10000, "minimum": 0, "type": "number", "description": "Specifies the width of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the width is unspecified.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text box width", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "10000" } }, "Height": { "maximum": 10000, "minimum": 0, "type": "number", "description": "Specifies the height of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the height is unspecified.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text box height", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "10000" } }, "LineSpacing": { "maximum": 30, "minimum": -30, "type": "integer", "description": "Specifies the watermark text line spacing.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text line spacing", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "-30", "to": "30" } }, "FontEmbed": { "type": "boolean", "description": "Specifies whether fonts should be embedded.", "default": true, "x-ca-featured": false, "x-ca-label": "Embed watermark font", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FontSubset": { "type": "boolean", "description": "Specifies whether fonts should be subset.", "default": true, "x-ca-featured": false, "x-ca-label": "Font subset", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Add professional text watermarks to PDF pages with granular styling and placement controls. Choose the text and font family, embed or subset fonts, set size, fill and stroke colors with stroke width, and pick the rendering mode. Adjust opacity and rotation, position the watermark within page or crop box, and target specific pages or ranges. Optionally attach a link or a go‑to page action and preserve or update PDF metadata as needed. Designed for automation, the API produces consistent, branded results across batches without manual editing.\n", "x-ca-overview-markdown": "Add professional text watermarks to PDF pages with granular styling and placement controls. Choose the text and font family, embed or subset fonts, set size, fill and stroke colors with stroke width, and pick the rendering mode. Adjust opacity and rotation, position the watermark within page or crop box, and target specific pages or ranges. Optionally attach a link or a go‑to page action and preserve or update PDF metadata as needed. Designed for automation, the API produces consistent, branded results across batches without manual editing.", "x-ca-meta-title": "Watermark PDF API - Stamp PDF Pages with Text Watermark", "x-ca-meta-description": "Add text watermarks to PDFs via API. Control font, size, color, stroke, opacity, rotation, position, page ranges, and links.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "watermark", "pdf", "featured" ] }, "/convert/pdf/to/tiff": { "summary": "PDF to TIFF API", "description": "Render PDF pages to TIFF images with password support, page range selection, resolution control, compression, and multipage.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-tiff" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Rotate": { "enum": [ "default", "none", "rotate90", "rotate180", "rotate270" ], "type": "string", "description": "Set PDF page rotation before converting to image.", "default": "default", "x-ca-featured": false, "x-ca-label": "Rotate page", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "none": "None", "rotate90": "Rotate 90", "rotate180": "Rotate 180", "rotate270": "Rotate 270" } }, "CropTo": { "enum": [ "BoundingBox", "TrimBox", "MediaBox", "ArtBox", "BleedBox" ], "type": "string", "description": "Defines the options for cropping the page.", "default": "BoundingBox", "x-ca-featured": false, "x-ca-label": "Crop to box", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "BoundingBox": "Bounding Box", "TrimBox": "Trim Box", "MediaBox": "Media Box", "ArtBox": "Art Box", "BleedBox": "Bleed Box" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Scale.md.", "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "FitToSize": { "type": "boolean", "description": "Gets or sets whether to scale the output image to fit within both ImageWidth and ImageHeight while maintaining the aspect ratio. When enabled, the image is sized to fit the more restrictive dimension. Requires both width and height to be specified.", "default": false, "x-ca-featured": false, "x-ca-label": "Fit to size", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BackgroundColor": { "type": "string", "description": "Applies a color to the transparent PDF background, thereby setting the background color of the generated images. You can specify a color name (e.g. `white` or `black`), or use color codes such as RGB (e.g. `255,0,0`) or HEX (e.g. `#FF0000`). To preserve transparency, set the property value to `transparent`.", "x-ca-featured": false, "x-ca-label": "Background Color", "x-ca-group": "TIFF Output", "x-ca-type": "Color", "x-ca-representation": "Default" }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ColorMode": { "enum": [ "default", "cmyk", "grayscale", "bitonal" ], "type": "string", "description": "Set color mode for result Tiff image.", "default": "default", "x-ca-featured": false, "x-ca-label": "Color Mode", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "cmyk": "Cmyk", "grayscale": "Grayscale", "bitonal": "Bitonal" } }, "BitDepth": { "enum": [ "default", "1", "2", "4", "8", "16" ], "type": "string", "description": "Set the number of bits per color channel in the output image. Higher values improve color precision and gradient smoothness but increase file size.", "default": "default", "x-ca-featured": false, "x-ca-label": "Bit depth", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "1": "1 bit", "2": "2 bits", "4": "4 bits", "8": "8 bits", "16": "16 bits" } }, "CompressionLevel": { "maximum": 9, "minimum": 0, "type": "integer", "description": "Define the compression level (0–9). A higher value increases compression, reducing file size. For lossy formats (JPG), this decreases image quality; for lossless formats (PNG), it increases compression strength without affecting quality.", "x-ca-featured": false, "x-ca-label": "Compression level", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "9" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to robust TIFF images suitable for long‑term archiving, print workflows, and interoperability. Handle password‑protected files and restrict processing to specific page ranges for targeted exports. Control output with image resolution (DPI) and explicit width/height to fit storage or layout constraints, choose color handling, and select compression to balance fidelity and file size. Generate single‑ or multi‑page TIFF to accommodate lengthy documents and produce consistent results across batches and varying inputs.\n", "x-ca-overview-markdown": "Convert PDF documents to robust TIFF images suitable for long‑term archiving, print workflows, and interoperability. Handle password‑protected files and restrict processing to specific page ranges for targeted exports. Control output with image resolution (DPI) and explicit width/height to fit storage or layout constraints, choose color handling, and select compression to balance fidelity and file size. Generate single‑ or multi‑page TIFF to accommodate lengthy documents and produce consistent results across batches and varying inputs.", "x-ca-meta-title": "PDF to TIFF Conversion API – Convert PDF to TIFF Images", "x-ca-meta-description": "Convert PDF to TIFF via API. Set page range, resolution, size, color/compression, and multipage output; handle passwords reliably.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "pdf", "image" ] }, "/convert/pdf/to/tiff-fax": { "summary": "PDF to TIFF Fax API", "description": "Render PDF pages to monochrome TIFF Fax images with CCITT Group 3/4 compression, password support, and multipage output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-tiff-fax" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "PDF", "x-ca-type": "String", "x-ca-representation": "Default" }, "TiffType": { "enum": [ "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF FAX type.", "default": "monochromeg4", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "ImageResolution": { "enum": [ "204x98", "204x196" ], "type": "string", "description": "Set output image resolution in dpi.", "default": "204x98", "x-ca-featured": false, "x-ca-label": "Image Resolution", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "204x98": "204x98 dpi", "204x196": "204x196 dpi" } }, "ImageWidth": { "enum": [ "1728", "2048", "2482" ], "type": "string", "description": "Image width in pixels.", "default": "1728", "x-ca-featured": false, "x-ca-label": "Image Width", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "1728": "1728 pixels (8.5 in)", "2048": "2048 pixels (10 in)", "2482": "2482 pixels (12.2 in)" } }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CropTo": { "enum": [ "BoundingBox", "TrimBox", "MediaBox", "ArtBox", "BleedBox" ], "type": "string", "description": "Defines the options for cropping the page.", "default": "BoundingBox", "x-ca-featured": false, "x-ca-label": "Crop to box", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "BoundingBox": "Bounding Box", "TrimBox": "Trim Box", "MediaBox": "Media Box", "ArtBox": "Art Box", "BleedBox": "Bleed Box" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to fax‑ready monochrome TIFF using CCITT Group 3 or Group 4 compression for compact, interoperable output. Handle password‑protected files and restrict processing to specific page ranges to create targeted exports. Control resolution (DPI) and explicit width/height to meet telephony or archive constraints, and produce single‑ or multi‑page TIFF as needed. Ideal for records workflows, legacy fax systems, and integrations requiring predictable black‑and‑white raster images with very small file sizes.\n", "x-ca-overview-markdown": "Convert PDF documents to fax‑ready monochrome TIFF using CCITT Group 3 or Group 4 compression for compact, interoperable output. Handle password‑protected files and restrict processing to specific page ranges to create targeted exports. Control resolution (DPI) and explicit width/height to meet telephony or archive constraints, and produce single‑ or multi‑page TIFF as needed. Ideal for records workflows, legacy fax systems, and integrations requiring predictable black‑and‑white raster images with very small file sizes.", "x-ca-meta-title": "PDF to TIFF Fax Conversion API – Fax‑ready TIFF Images", "x-ca-meta-description": "Convert PDF to monochrome TIFF Fax via API. Use CCITT G3/G4 compression, set page range, resolution, size, and output single or multipage TIFF.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "pdf", "image" ] }, "/convert/pdf/to/txt": { "summary": "PDF to Text API", "description": "Extract text from PDF documents to plain text files with password support, optional OCR, page range, and formatting control.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-txt" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "IncludeFormatting": { "type": "boolean", "description": "Persist formatting while extracting text. Only works when RemoveHeadersFooters and RemoveFootnotes properties are disabled.", "default": false, "x-ca-featured": false, "x-ca-label": "Include Formatting", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SplitPages": { "type": "boolean", "description": "Split each page to different result file.", "default": false, "x-ca-featured": false, "x-ca-label": "Split Pages", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveHeadersFooters": { "type": "boolean", "description": "Remove headers and footers from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Headers and Footers", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveFootnotes": { "type": "boolean", "description": "Remove footnotes from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Footnotes", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveTables": { "type": "boolean", "description": "Remove tables from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Tables", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert a textual and scanned PDF document to a plain text file, extract text from a PDF, and apply OCR on a scanned PDF document before conversion.\n", "x-ca-overview-markdown": "Convert a textual and scanned PDF document to a plain text file, extract text from a PDF, and apply OCR on a scanned PDF document before conversion.", "x-ca-meta-title": "PDF to Text API – Extract plain text from PDF documents", "x-ca-meta-description": "Convert PDF documents to plain text files. Extract text from textual and scanned PDFs with optional OCR for searchable results.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "txt", "x-ca-tags": [ "pdf", "extract", "ocr", "featured" ] }, "/convert/pdf/to/unprotect": { "summary": "Unprotect PDF API", "description": "Remove passwords and restrictions from secured PDFs to enable printing, editing, copying, and full document processing access.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-unprotect" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Enter user password to remove User protection. Leave the parameter empty to remove Owner protection.", "x-ca-featured": true, "x-ca-label": "Decrypt Password", "x-ca-group": "Decryption", "x-ca-type": "String", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Unlock secured PDF documents to regain full access for reading and processing. Remove user or owner password protection when credentials are available, lifting restrictions on printing, copying, editing, form filling, and annotations. Process single files or batches consistently and integrate unprotection into upstream workflows such as OCR, metadata extraction, redaction, and archival. Ideal for organizations standardizing document intake where protected PDFs must be normalized before downstream automation.\n", "x-ca-overview-markdown": "Unlock secured PDF documents to regain full access for reading and processing. Remove user or owner password protection when credentials are available, lifting restrictions on printing, copying, editing, form filling, and annotations. Process single files or batches consistently and integrate unprotection into upstream workflows such as OCR, metadata extraction, redaction, and archival. Ideal for organizations standardizing document intake where protected PDFs must be normalized before downstream automation.", "x-ca-meta-title": "Unprotect PDF API – Remove passwords and restrictions", "x-ca-meta-description": "Unlock secured PDFs via API. Remove user/owner passwords and lift restrictions to enable printing, editing, copying, and extraction.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "security", "pdf" ] }, "/convert/pdf/to/webp": { "summary": "PDF to WebP API", "description": "Render PDF pages to WebP images with password support, page range, lossless or lossy compression, and quality control.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-webp" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleProportions": { "type": "boolean", "description": "If set to true, the barcode will be generated using recommended proportions based on the larger dimension.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale Proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageAntialiasing": { "maximum": 8, "minimum": 0, "type": "integer", "description": "Control the use of text and graphics subsample antialiasing. The subsampling box size should be 8 bits for optimum text antialiasing, but smaller values can be used for faster rendering.", "default": 8, "x-ca-featured": false, "x-ca-label": "Image antialiasing", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "8" } }, "Rotate": { "maximum": 360, "minimum": -360, "type": "integer", "description": "Rotate image by angle.", "x-ca-featured": false, "x-ca-label": "Rotate image", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "-360", "to": "360" } }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "WebP Output", "x-ca-type": "Color", "x-ca-representation": "Default" }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 900, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to modern WebP images to reduce file sizes while preserving visual fidelity. Handle password‑protected files and restrict processing to specific page ranges. Control output with image resolution (DPI), scale proportions with explicit width/height to match UI or storage constraints, and apply anti‑aliasing for crisp rendering. Choose lossless or lossy compression and adjust quality to balance clarity and size, and optionally map a color to transparency for predictable results. Ideal for web and mobile delivery, batch optimization, and CDN pipelines where small, faithful images are required.\n", "x-ca-overview-markdown": "Convert PDF documents to modern WebP images to reduce file sizes while preserving visual fidelity. Handle password‑protected files and restrict processing to specific page ranges. Control output with image resolution (DPI), scale proportions with explicit width/height to match UI or storage constraints, and apply anti‑aliasing for crisp rendering. Choose lossless or lossy compression and adjust quality to balance clarity and size, and optionally map a color to transparency for predictable results. Ideal for web and mobile delivery, batch optimization, and CDN pipelines where small, faithful images are required.", "x-ca-meta-title": "PDF to WebP Conversion API – Convert PDF to WebP Images", "x-ca-meta-description": "Convert PDF to WebP via API. Set page range, resolution, width/height, scaling, anti‑aliasing; choose lossless/lossy and quality; handle passwords.", "x-ca-keywords": "", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "webp", "x-ca-tags": [ "pdf", "image" ] }, "/convert/pdf/to/xlsx": { "summary": "PDF to XLSX API", "description": "Convert PDFs to Excel (XLSX) preserving tables, text, and layout with password, page ranges, locale separators, and OCR support.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/pdf-to-xlsx" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "File to be converted. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "PageRange": { "type": "string", "description": "Set page range or individual pages to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "IncludeFormatting": { "type": "boolean", "description": "Include non-table content in an excel file, like images and paragraphs.", "default": false, "x-ca-featured": false, "x-ca-label": "Include Formatting", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SingleSheet": { "type": "boolean", "description": "Combine extracted tables into a single sheet.", "default": false, "x-ca-featured": false, "x-ca-label": "Single Sheet", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "DecimalSeparator": { "enum": [ "auto", "period", "comma" ], "type": "string", "description": "Defines the character used as a decimal separator in numeric values.\r\n\r\n- **auto** _(default)_: Automatically detects the decimal separator based on the formatting within the document.\r\n- **period**: Forces usage of period (`.`) as the decimal separator.\r\n- **comma**: Forces usage of comma (`,`) as the decimal separator.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Decimal Separator", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "period": "Period", "comma": "Comma" } }, "ThousandsSeparator": { "enum": [ "auto", "period", "comma", "space" ], "type": "string", "description": "Defines the character used as a thousands separator in numeric values.\r\n\r\n- **auto** _(default)_: Automatically detects the thousands separator based on the formatting within the document.\r\n- **period**: Forces usage of period (`.`) as the thousands separator.\r\n- **comma**: Forces usage of comma (`,`) as the thousands separator.\r\n- **space**: Forces usage of space (` `) as the thousands separator.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Thousands Separator", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "period": "Period", "comma": "Comma", "space": "Space" } }, "StoreFile": { "type": "boolean", "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Store file", "x-ca-group": "Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 600, "x-ca-featured": false, "x-ca-label": "Timeout", "x-ca-group": "Execution", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1200" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Convert PDF documents to Excel (XLSX) worksheets with high fidelity for analysis and automation. Preserve tables, text, numbers, and basic formatting to minimize cleanup, and restrict processing to specific page ranges for targeted exports. Handle password‑protected files, select OCR mode/engine and languages to recover content from scans, and output onto a single sheet when desired. Normalize data for pipelines by setting decimal and thousands separators aligned to your locale. Built for batch processing with predictable results.\n", "x-ca-overview-markdown": "Convert PDF documents to Excel (XLSX) worksheets with high fidelity for analysis and automation. Preserve tables, text, numbers, and basic formatting to minimize cleanup, and restrict processing to specific page ranges for targeted exports. Handle password‑protected files, select OCR mode/engine and languages to recover content from scans, and output onto a single sheet when desired. Normalize data for pipelines by setting decimal and thousands separators aligned to your locale. Built for batch processing with predictable results.", "x-ca-meta-title": "PDF to XLSX API – Extract tables from PDF to Excel XLSX", "x-ca-meta-description": "Convert PDFs to Excel via API. Preserve tables and text; handle passwords and ranges; choose OCR and locale separators; export to a single sheet.", "x-ca-keywords": "pdf, pptx, excel, office", "x-ca-source-formats": "pdf", "x-ca-destination-formats": "xlsx", "x-ca-tags": [ "pdf", "extract", "spreadsheet", "featured" ] } }, "components": { "schemas": { "fileId": { "maxLength": 32, "minLength": 32, "type": "string", "description": "Uploaded File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "error": { "type": "object", "properties": { "Code": { "type": "integer", "description": "Error message code", "format": "int32", "example": 4000 }, "Message": { "type": "string", "description": "Error message text", "example": "Parameter validation error." } }, "externalDocs": { "url": "https://www.convertapi.com/doc/response-codes" } } }, "responses": { "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "415": { "description": "File type error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "500": { "description": "Conversion failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "503": { "description": "Conversion rate limit error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } }, "parameters": { "fileId": { "name": "fileId", "in": "path", "description": "File ID", "required": true, "schema": { "$ref": "#/components/schemas/fileId" } }, "src": { "name": "src", "in": "path", "description": "Source file format (docx, pdf, jpg etc.)", "required": true, "schema": { "type": "string" } }, "dst": { "name": "dst", "in": "path", "description": "Destination file format (docx, pdf, jpg etc.)", "required": true, "schema": { "type": "string" } } }, "headers": { "content-disposition": { "description": "File information ([docummentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition))", "schema": { "type": "string" } }, "file-name": { "description": "File name", "schema": { "type": "string" } }, "file-ext": { "description": "File name extension", "schema": { "type": "string" } }, "file-size": { "description": "File size", "schema": { "type": "integer" } } }, "securitySchemes": { "secret": { "type": "http", "description": "[Get `Secret`](https://www.convertapi.com/a/secret)", "scheme": "bearer" }, "token": { "type": "http", "description": "[Get `Token`](https://www.convertapi.com/a/api-tokens)", "scheme": "bearer" }, "jwt": { "type": "http", "description": "[Get `JWT`](https://www.convertapi.com/a/jwt-tokens)", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Conversion", "description": "File Conversion API call", "externalDocs": { "description": "File Conversion related operations", "url": "https://www.convertapi.com/doc/content-types" } }, { "name": "File Server", "description": "ConvertAPI temporary file storage", "externalDocs": { "description": "File Server related operations", "url": "https://www.convertapi.com/doc/upload" } }, { "name": "User", "description": "API User", "externalDocs": { "description": "API User related operations", "url": "https://www.convertapi.com/doc/user" } } ], "externalDocs": { "description": "Find out more about ConvertAPI", "url": "https://www.convertapi.com/doc" } }