Another paragraph here.
\",\r\n \"Type\": \"html\",\r\n \"Link\": \"https://www.example.com\"\r\n },\r\n {\r\n \"Name\": \"MyCondition\",\r\n \"Value\": \"false\",\r\n \"Type\": \"conditional\"\r\n }\r\n]\r\n```", "x-ca-featured": true, "x-ca-label": "JSON payload", "x-ca-group": "Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "BindingMethod": { "enum": [ "properties", "placeholders" ], "type": "string", "description": "Choose the binding method. Select whether the converter should fill data from Word document properties fields or search for placeholders within the text.\n * `properties` - Property fields\n * `placeholders` - Placeholders", "default": "properties", "x-ca-featured": true, "x-ca-label": "Template binding method", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "properties": "Property fields", "placeholders": "Placeholders" } } } } } } }, "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": "Dynamic PDF API is a tool that allows you to dynamically generate PDF documents based on a MS Word (DOCX) template by injecting custom properties using a JSON object that contains your data. It's a game changer for anyone who wants to generate custom PDF documents on the fly. Using our DOCX Template API, you can effortlessly create stunning PDF documents like invoices, contracts, agreements, etc. It allows you to generate dynamic proposals or quotes using your desired DOCX template as a basis for the final PDF document.", "x-ca-meta-title": "Dynamic PDF API: Create dynamic PDFs with MS Word template and JSON - ConvertAPI", "x-ca-meta-description": "Dynamic PDF API is a tool that allows you to generate dynamic PDFs by injecting custom document variables into an MS Word template by passing a JSON object containing your data.", "x-ca-source-formats": "docx,dotx", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "template", "document", "office", "pdf" ] }, "/convert/tiff/to/pdf": { "summary": "TIFF to PDF API", "description": "Convert TIFF images to PDF with controls for page size, orientation, margins, rotation, color settings, and optional PDF/A compliance.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "tif", "tiff" ] }, "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" } }, "Rotate": { "maximum": 360, "minimum": -360, "type": "integer", "description": "Rotate the image by a specified degree. For automatic rotation using EXIF data in TIFF and JPEG images, leave this property empty.", "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" } }, "ColorSpace": { "enum": [ "default", "rgb", "srgb", "cmyk", "gray" ], "type": "string", "description": "Set image color space.\n * `default` - Default\n * `rgb` - RGB\n * `srgb` - sRGB\n * `cmyk` - CMYK\n * `gray` - Gray", "default": "default", "x-ca-featured": false, "x-ca-label": "Image color space", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ColorProfile": { "enum": [ "default", "isocoatedv2" ], "type": "string", "description": "Set image color profile. Some profiles will override the ColorSpace property.\n * `default` - Default\n * `isocoatedv2` - ISO Coated v2", "default": "default", "x-ca-featured": false, "x-ca-label": "Image color profile", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "isocoatedv2": "ISO Coated v2" } }, "MarginHorizontal": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page horizontal margin in millimeters (mm).", "default": 0, "x-ca-featured": false, "x-ca-label": "Horizontal margin", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginVertical": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page vertical margin in millimeters (mm).", "default": 0, "x-ca-featured": false, "x-ca-label": "Vertical margin", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "PageSize": { "enum": [ "default", "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "a10", "letter", "legal" ], "type": "string", "description": "The property scales each image to fit a given page size.\n * `default` - Image size\n * `a0` - A0\n * `a1` - A1\n * `a2` - A2\n * `a3` - A3\n * `a4` - A4\n * `a5` - A5\n * `a6` - A6\n * `a7` - A7\n * `a8` - A8\n * `a9` - A9\n * `a10` - A10\n * `letter` - Letter\n * `legal` - Legal", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Image size", "a0": "A0", "a1": "A1", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "a7": "A7", "a8": "A8", "a9": "A9", "a10": "A10", "letter": "Letter", "legal": "Legal" } }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Set page orientation. Works only with the PageSize property when it is set to a value other than the Image size.\n * `default` - Image orientation\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Image orientation", "portrait": "Portrait", "landscape": "Landscape" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AlphaChannel": { "type": "boolean", "description": "Enable or disable the alpha channel if available.", "default": false, "x-ca-featured": false, "x-ca-label": "Alpha channel", "x-ca-group": "Image", "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": "TIFF to PDF conversion API is a powerful and flexible solution for users looking to transform TIFF images into PDF format. It supports various programming languages, making it highly accessible for a wide range of developers. The API provides features like adjusting page margins, choosing page orientations, and rotating images to ensure the final PDF meets specific requirements. This API is ideal for businesses and developers seeking a reliable and versatile image-to-PDF conversion tool.", "x-ca-meta-title": "TIFF to PDF Conversion API – Convert TIFF to PDF", "x-ca-meta-description": "Convert TIFF to PDF via API. Control page size, orientation, margins, rotation, color, and PDF/A for compliant archiving.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "image", "pdf" ] }, "/convert/txt/to/pdf": { "summary": "Text to PDF API", "description": "Convert plain text files to PDF with page parameters.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/txt-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "txt" ] }, "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. Example 1-10.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Page Options", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "6000" } }, "FontName": { "enum": [ "Arial", "Bahnschrift", "Calibri", "Cambria", "Consolas", "Constantia", "CourierNew", "Georgia", "Tahoma", "TimesNewRoman", "Verdana" ], "type": "string", "description": "Specifies the text font name. Contact us if you are looking for a specific font for a text that is missing from the list.\n * `Arial` - Arial\n * `Bahnschrift` - Bahnschrift\n * `Calibri` - Calibri\n * `Cambria` - Cambria\n * `Consolas` - Consolas\n * `Constantia` - Constantia\n * `CourierNew` - Courier New\n * `Georgia` - Georgia\n * `Tahoma` - Tahoma\n * `TimesNewRoman` - Times New Roman\n * `Verdana` - Verdana", "default": "CourierNew", "x-ca-featured": false, "x-ca-label": "Text font name", "x-ca-group": "Text", "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" } }, "FontSize": { "maximum": 72, "minimum": 4, "type": "integer", "description": "Specifies the text font size.", "default": 12, "x-ca-featured": false, "x-ca-label": "Text font size", "x-ca-group": "Text", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "4", "to": "72" } }, "PageOrientation": { "enum": [ "portrait", "landscape" ], "type": "string", "description": "Set page orientation.\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "portrait", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "letter", "lettersmall", "tabloid", "ledger", "legal", "statement", "executive", "a3", "a4", "a4small", "a5", "b4", "b5" ], "type": "string", "description": "Page size.\n * `letter` - Letter\n * `lettersmall` - Letter Small\n * `tabloid` - Tabloid\n * `ledger` - Ledger\n * `legal` - Legal\n * `statement` - Statement\n * `executive` - Executive\n * `a3` - A3\n * `a4` - A4\n * `a4small` - A4 Small\n * `a5` - A5\n * `b4` - B4\n * `b5` - B5", "default": "a4", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "letter": "Letter", "lettersmall": "Letter Small", "tabloid": "Tabloid", "ledger": "Ledger", "legal": "Legal", "statement": "Statement", "executive": "Executive", "a3": "A3", "a4": "A4", "a4small": "A4 Small", "a5": "A5", "b4": "B4", "b5": "B5" } }, "MarginLeft": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page left margin in millimeters (mm).", "default": 5, "x-ca-featured": false, "x-ca-label": "Margin left", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginRight": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page right margin in millimeters (mm).", "default": 5, "x-ca-featured": false, "x-ca-label": "Margin right", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginTop": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page top margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin top", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginBottom": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page bottom margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin bottom", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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": "Easily turn text, logs, and plain text files into PDFs or PDF/A with our TXT to PDF API. Set page size, orientation, and margins as you like, and make your PDFs smaller with our compression feature. Great for anyone needing quick and flexible text document conversion API.", "x-ca-meta-title": "TXT to PDF API: Convert Text, Logs to PDF/PDF-A. Customize & Compress", "x-ca-meta-description": "Convert text, logs to PDF/PDF-A easily. Customize page size, orientation, margins, and compress files with our flexible text to PDF conversion API.", "x-ca-source-formats": "txt", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "pdf" ] }, "/convert/vsdx/to/pdf": { "summary": "VSDX to PDF API", "description": "Convert Microsoft Visio VSD and VSDX diagrams to PDF documents with full layout preservation, layers support and high fidelity.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/vsdx-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "vsd", "vsdx" ] }, "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": "Visio", "x-ca-type": "String", "x-ca-representation": "Default" }, "IncludeBackground": { "type": "boolean", "description": "Include background pages.", "default": true, "x-ca-featured": false, "x-ca-label": "IncludeBackground", "x-ca-group": "Visio", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ColorAsBlack": { "type": "boolean", "description": "Render all colors in the converting document as black.", "default": false, "x-ca-featured": false, "x-ca-label": "ColorAsBlack", "x-ca-group": "Visio", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertMetadata": { "type": "boolean", "description": "Convert document metadata like Title, Author, Keywords to PDF metadata.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert metadata", "x-ca-group": "Visio", "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.\n * `1.2` - Acrobat 3 (PDF 1.2)\n * `1.3` - Acrobat 4 (PDF 1.3)\n * `1.4` - Acrobat 5 (PDF 1.4)\n * `1.5` - Acrobat 6 (PDF 1.5)\n * `1.6` - Acrobat 7 (PDF 1.6)\n * `1.7` - Acrobat 8 (PDF 1.7)\n * `1.8` - Acrobat 9 (PDF 1.7, e-level 3)\n * `2.0` - Acrobat DC (PDF 2.0)", "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)" } }, "PdfResolution": { "maximum": 2400, "minimum": 10, "type": "integer", "description": "Set PDF resolution.", "default": 300, "x-ca-featured": false, "x-ca-label": "PDF resolution", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "2400" } }, "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" }, "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 .\n * `Default` - Default\n * `ActualSize` - Actual Size\n * `FitPage` - Fit Page\n * `FitWidth` - Fit Width\n * `FitHeight` - Fit Height\n * `FitVisible` - Fit Visible\n * `25` - 25%\n * `50` - 50%\n * `75` - 75%\n * `100` - 100%\n * `125` - 125%\n * `150` - 150%\n * `200` - 200%\n * `400` - 400%\n * `800` - 800%\n * `1600` - 1600%\n * `2400` - 2400%\n * `3200` - 3200%\n * `6400` - 6400%", "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%" } }, "RotatePage": { "enum": [ "Disabled", "ByPage", "All" ], "type": "string", "description": "Automatically rotate pages based on the orientation of the text. By Page option will rotate each page based on the direction of the text on that page. All option will rotate all pages in the document based on the orientation of the majority of text.\n * `Disabled` - Disabled\n * `ByPage` - By Page\n * `All` - All", "default": "ByPage", "x-ca-featured": false, "x-ca-label": "Auto rotate page", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Disabled": "Disabled", "ByPage": "By Page", "All": "All" } }, "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" }, "SubsetFontsThreshold": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Sets the Subset Fonts threshold. If the percentage of used characters, compared with total characters of the particular font, exceeds this threshold, the entire font is embedded.", "default": 100, "x-ca-featured": false, "x-ca-label": "Subset fonts threshold", "x-ca-group": "PDF Fonts", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "100" } }, "ColorSpace": { "enum": [ "Default", "RGB", "CMYK", "Gray" ], "type": "string", "description": "Set PDF color space.\n * `Default` - Default\n * `RGB` - RGB\n * `CMYK` - CMYK\n * `Gray` - Gray", "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" } } } } } } }, "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 Visio VSD/VSDX diagrams to PDF for easy sharing, review, and archiving. Preserves page layout, layers, shapes, text, and connectors. Optionally embed document metadata and fine‑tune PDF output settings.", "x-ca-meta-title": "Visio to PDF Conversion API – Shareable PDF Diagrams", "x-ca-meta-description": "Convert Visio VSD/VSDX to PDF via API. Preserve layout and content, with metadata options for reliable sharing and archiving.", "x-ca-source-formats": "vsd,vsdx", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "drawing", "office", "pdf" ] }, "/convert/web/to/pdf": { "summary": "Web to PDF API", "description": "Convert live web pages to PDF with page layout, headers/footers, and range controls.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/web-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Url" ], "type": "object", "properties": { "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" }, "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" } }, "Timeout": { "maximum": 1200, "minimum": 10, "type": "integer", "description": "Conversion timeout in seconds.", "default": 120, "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" } }, "ConversionDelay": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.", "default": 0, "x-ca-featured": false, "x-ca-label": "Conversion delay", "x-ca-group": "Web Rendering", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "Version": { "enum": [ "latest", "130", "126", "117" ], "type": "string", "description": "Specify a particular version of the Chromium engine to render the web page.\n * `latest` - Latest (140)\n * `130` - 130\n * `126` - 126\n * `117` - 117", "default": "117", "x-ca-featured": false, "x-ca-label": "Chromium Version", "x-ca-group": "Web Rendering", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "latest": "Latest (140)", "130": "130", "126": "126", "117": "117" } }, "AuthUsername": { "type": "string", "description": "HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.", "x-ca-featured": false, "x-ca-label": "Authentication username", "x-ca-group": "Request", "x-ca-type": "String", "x-ca-representation": "Default" }, "AuthPassword": { "type": "string", "description": "HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.", "x-ca-featured": false, "x-ca-label": "Authentication password", "x-ca-group": "Request", "x-ca-type": "String", "x-ca-representation": "Default" }, "AdBlock": { "type": "boolean", "description": "Block ads in converting page.", "default": false, "x-ca-featured": false, "x-ca-label": "Ad block", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CookieConsentBlock": { "type": "boolean", "description": "Tries to remove EU regulation required cookie warnings from web pages.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove cookie warnings", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Cookies": { "type": "string", "description": "Set additional cookies for the page request. Example: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3", "x-ca-featured": false, "x-ca-label": "Cookies for the page request", "x-ca-group": "Request", "x-ca-type": "String", "x-ca-representation": "Default" }, "JavaScript": { "type": "boolean", "description": "Allow web pages to run JavaScript.", "default": true, "x-ca-featured": false, "x-ca-label": "Enable JavaScript", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "WaitElement": { "type": "string", "description": "Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.", "x-ca-featured": false, "x-ca-label": "Wait for DOM element", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "UserJs": { "type": "string", "description": "Execute provided JavaScript before conversion begins.", "x-ca-featured": false, "x-ca-label": "Execute JavaScript", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "UserCss": { "type": "string", "description": "Apply additional CSS before conversion begins.", "x-ca-featured": false, "x-ca-label": "Apply additional CSS", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "HideElements": { "type": "string", "description": "Element selector string of the DOM elements that needs to be hidden during conversion.", "x-ca-featured": false, "x-ca-label": "Hide DOM elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "CssMediaType": { "type": "string", "description": "Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.", "default": "screen", "x-ca-featured": false, "x-ca-label": "CSS media type", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "Headers": { "type": "string", "description": "Set custom HTTP headers to include in the request. Format: `Header1:Value1|Header2:Value2|Header3:Value3`\r\n\r\n- Each header is separated by `|`.\r\n- Each name/value pair is separated by `:`.", "x-ca-featured": false, "x-ca-label": "Custom Headers", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "LoadLazyContent": { "type": "boolean", "description": "Load page images that loads only when they are visible.", "default": false, "x-ca-featured": false, "x-ca-label": "Load lazy content", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ViewportWidth": { "maximum": 4000, "minimum": 200, "type": "integer", "description": "Sets browser viewport width.", "default": 1366, "x-ca-featured": false, "x-ca-label": "Viewport width", "x-ca-group": "Web Rendering", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "200", "to": "4000" } }, "ViewportHeight": { "maximum": 4000, "minimum": 200, "type": "integer", "description": "Sets browser viewport height.", "default": 1024, "x-ca-featured": false, "x-ca-label": "Viewport height", "x-ca-group": "Web Rendering", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "200", "to": "4000" } }, "RespectViewport": { "type": "boolean", "description": "If true, the converter will generate PDF as the content looks like in the browser. If is set to false, the converter acts like Chrome print to PDF function.", "default": true, "x-ca-featured": false, "x-ca-label": "Respect viewport", "x-ca-group": "Page Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Scale": { "maximum": 200, "minimum": 10, "type": "integer", "description": "Set web page scale value in percentage.", "default": 100, "x-ca-featured": false, "x-ca-label": "Scale Content", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "200" } }, "PageOrientation": { "enum": [ "portrait", "landscape" ], "type": "string", "description": "PDF page orientation.\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "portrait", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "b0", "b1", "b2", "b3", "b4", "b5", "letter", "legal", "ledger" ], "type": "string", "description": "PDF page size.\n * `a0` - A0\n * `a1` - A1\n * `a2` - A2\n * `a3` - A3\n * `a4` - A4\n * `a5` - A5\n * `a6` - A6\n * `a7` - A7\n * `a8` - A8\n * `a9` - A9\n * `b0` - B0\n * `b1` - B1\n * `b2` - B2\n * `b3` - B3\n * `b4` - B4\n * `b5` - B5\n * `letter` - Letter\n * `legal` - Legal\n * `ledger` - Ledger", "default": "letter", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "a0": "A0", "a1": "A1", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "a7": "A7", "a8": "A8", "a9": "A9", "b0": "B0", "b1": "B1", "b2": "B2", "b3": "B3", "b4": "B4", "b5": "B5", "letter": "Letter", "legal": "Legal", "ledger": "Ledger" } }, "PageWidth": { "maximum": 30000, "minimum": 10, "type": "integer", "description": "Custom page width in millimeters (mm). This option override PageSize option.", "x-ca-featured": false, "x-ca-label": "Page width", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "30000" } }, "PageHeight": { "maximum": 30000, "minimum": 10, "type": "integer", "description": "Custom page height in millimeters (mm). This option override PageSize option.", "x-ca-featured": false, "x-ca-label": "Page height", "x-ca-group": "PDF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "30000" } }, "MarginTop": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page top margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin top", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginRight": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page right margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin right", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginBottom": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page bottom margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin bottom", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginLeft": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page left margin in millimeters (mm).", "default": 10, "x-ca-featured": false, "x-ca-label": "Margin left", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "PageRange": { "type": "string", "description": "Set page range. Example 1-10 or 1,2,5.", "default": "1-100", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "Background": { "type": "boolean", "description": "Convert web page background.", "default": true, "x-ca-featured": false, "x-ca-label": "Background", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FixedElements": { "enum": [ "fixed", "absolute", "relative", "hide" ], "type": "string", "description": "Change fixed elements CSS 'position' property to adapt page for conversion.\n * `fixed` - Leave unchanged\n * `absolute` - Absolute\n * `relative` - Relative\n * `hide` - Hide", "default": "fixed", "x-ca-featured": false, "x-ca-label": "Fixed elements", "x-ca-group": "Web Rendering", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "fixed": "Leave unchanged", "absolute": "Absolute", "relative": "Relative", "hide": "Hide" } }, "Header": { "type": "string", "description": "This property will insert an HTML header into each page. HTML tags containing the classes `pageNumber`, `totalPages`, `title`, and `date` will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.\r\n\r\n```html\r\n\r\n\r\n page number \r\n \r\n\r\n\r\n date \r\n \r\n\r\n```", "x-ca-featured": false, "x-ca-label": "Header HTML", "x-ca-group": "Page Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "Footer": { "type": "string", "description": "This property will insert an HTML footer into each page. HTML tags containing the classes `pageNumber`, `totalPages`, `title`, and `date` will be filled in with the metadata relevant to each individual page. Inline CSS could be utilized to style the HTML provided.\r\n\r\n```html\r\n\r\n\r\n page number \r\n \r\n\r\n\r\n date \r\n \r\n\r\n```", "x-ca-featured": false, "x-ca-label": "Footer HTML", "x-ca-group": "Page Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "ShowElements": { "type": "string", "description": "Element selector string of the DOM elements that should be visible during conversion. Other elements will be hidden.", "x-ca-featured": false, "x-ca-label": "Show DOM elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "AvoidBreakElements": { "type": "string", "description": "CSS selector for the elements that pages should not break.", "x-ca-featured": false, "x-ca-label": "Avoid page break inside DOM elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "BreakBeforeElements": { "type": "string", "description": "CSS selector for the elements that should apply page break before it.", "x-ca-featured": false, "x-ca-label": "Page break before DOM elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "BreakAfterElements": { "type": "string", "description": "CSS selector for the elements that should apply page break after it.", "x-ca-featured": false, "x-ca-label": "Page break after DOM elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "Url": { "type": "string", "description": "URI of a web page to convert. If URI has special characters like ? or & they must be encoded.", "format": "uri", "x-ca-featured": true, "x-ca-label": "URL to convert", "x-ca-group": "Input", "x-ca-type": "Uri", "x-ca-representation": "Url" } } } } } }, "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": "Turn any website (URL input) into a pixel‑perfect PDF using a modern headless browser renderer. Control viewport and page layout with size, orientation, custom width/height, margins, and page ranges. Add headers and footers, keep backgrounds, pin fixed elements, and fine‑tune pagination by avoiding or inserting page breaks around specific selectors. For dynamic sites, run JavaScript, wait for an element, and inject your own JS/CSS. Access gated content with custom headers, cookies, and basic auth; block ads and cookie‑consent banners; hide elements; and adjust timeouts/delays for reliable rendering.", "x-ca-meta-title": "Web to PDF Conversion API – Page Layout Control", "x-ca-meta-description": "Convert websites to PDF via API. Control page size, margins, headers/footers, ranges, backgrounds, waits, JS/CSS, headers, cookies, and auth.", "x-ca-source-formats": "web", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "html", "pdf", "featured" ] }, "/convert/webp/to/pdf": { "summary": "WebP to PDF API", "description": "Convert WebP images to PDF for sharing and archiving. Control page size, orientation, margins, rotation, color, and optional PDF/A.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "webp" ] }, "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" } }, "Rotate": { "maximum": 360, "minimum": -360, "type": "integer", "description": "Rotate the image by a specified degree. For automatic rotation using EXIF data in TIFF and JPEG images, leave this property empty.", "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" } }, "ColorSpace": { "enum": [ "default", "rgb", "srgb", "cmyk", "gray" ], "type": "string", "description": "Set image color space.\n * `default` - Default\n * `rgb` - RGB\n * `srgb` - sRGB\n * `cmyk` - CMYK\n * `gray` - Gray", "default": "default", "x-ca-featured": false, "x-ca-label": "Image color space", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ColorProfile": { "enum": [ "default", "isocoatedv2" ], "type": "string", "description": "Set image color profile. Some profiles will override the ColorSpace property.\n * `default` - Default\n * `isocoatedv2` - ISO Coated v2", "default": "default", "x-ca-featured": false, "x-ca-label": "Image color profile", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "isocoatedv2": "ISO Coated v2" } }, "MarginHorizontal": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page horizontal margin in millimeters (mm).", "default": 0, "x-ca-featured": false, "x-ca-label": "Horizontal margin", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "MarginVertical": { "maximum": 500, "minimum": 0, "type": "integer", "description": "Set the page vertical margin in millimeters (mm).", "default": 0, "x-ca-featured": false, "x-ca-label": "Vertical margin", "x-ca-group": "Page Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "500" } }, "PageSize": { "enum": [ "default", "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7", "a8", "a9", "a10", "letter", "legal" ], "type": "string", "description": "The property scales each image to fit a given page size.\n * `default` - Image size\n * `a0` - A0\n * `a1` - A1\n * `a2` - A2\n * `a3` - A3\n * `a4` - A4\n * `a5` - A5\n * `a6` - A6\n * `a7` - A7\n * `a8` - A8\n * `a9` - A9\n * `a10` - A10\n * `letter` - Letter\n * `legal` - Legal", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Image size", "a0": "A0", "a1": "A1", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "a7": "A7", "a8": "A8", "a9": "A9", "a10": "A10", "letter": "Letter", "legal": "Legal" } }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Set page orientation. Works only with the PageSize property when it is set to a value other than the Image size.\n * `default` - Image orientation\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Page Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Image orientation", "portrait": "Portrait", "landscape": "Landscape" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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 WebP images to PDF for convenient sharing, printing, and archival. Control page size and orientation, configure horizontal and vertical margins, and rotate content to match layout expectations. Set color handling and apply an ICC color profile for predictable rendering across devices and workflows. Enable PDF/A compliance when long‑term preservation is required. Ideal for digitization pipelines, records management, and distributing raster graphics as portable documents.", "x-ca-meta-title": "WebP to PDF Conversion API – Convert WebP to PDF", "x-ca-meta-description": "Convert WebP to PDF via API. Control page size, orientation, margins, rotation, color, and PDF/A for compliant archiving.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "image", "pdf" ] }, "/convert/wpd/to/pdf": { "summary": "WPD to PDF API", "description": "Convert WordPerfect (WPD) documents to PDF. Open passwords, set page range, convert markups/tags/headings/bookmarks, and enable PDF/A.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/wpd-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "wpd" ] }, "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": "Word", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set page range. Example 1-10.", "default": "1-6000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "Word", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "6000" } }, "ConvertMarkups": { "type": "boolean", "description": "Convert document markups like revisions and comments.", "default": false, "x-ca-featured": false, "x-ca-label": "Convert markups", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertTags": { "type": "boolean", "description": "Convert document structure tags for accessibility.", "default": false, "x-ca-featured": false, "x-ca-label": "Convert accessibility tags", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertMetadata": { "type": "boolean", "description": "Convert document metadata like Title, Author, Keywords to PDF metadata.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert metadata", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertHeadings": { "type": "boolean", "description": "Convert Word headings to PDF bookmarks.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert headings", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertBookmarks": { "type": "boolean", "description": "Convert Word bookmarks to PDF bookmarks.", "default": false, "x-ca-featured": false, "x-ca-label": "Convert bookmarks", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UpdateToc": { "type": "boolean", "description": "Update all tables of content in the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Update tables of content", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-3b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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 WordPerfect (WPD) documents to high‑quality PDF for distribution, review, and archiving. Open password‑protected files when required, restrict conversion to a specific page range, and include markups, tags, headings, and bookmarks to preserve structure. Optionally convert document metadata and enable PDF/A compliance for long‑term preservation. Designed for automation, the API produces predictable results across varied inputs without desktop tools.", "x-ca-meta-title": "WPD to PDF Conversion API – Convert WordPerfect to PDF.", "x-ca-meta-description": "Convert WPD to PDF via API. Handle passwords, set page range, include markups/tags/headings/bookmarks, convert metadata, and enable PDF/A.", "x-ca-source-formats": "wpd", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "document", "office", "pdf" ] }, "/convert/xlsb/to/pdf": { "summary": "XLSB to PDF API", "description": "Convert XLSB workbooks to PDF. Choose worksheet, control page size/orientation, auto‑fit, scaling, headers, passwords, and PDF/A.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsb-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "xlsb" ] }, "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": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "WorksheetActive": { "type": "boolean", "description": "Set to convert active worksheet. If value is set False all worksheet will be converted.", "default": false, "x-ca-featured": false, "x-ca-label": "Worksheet Active", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "WorksheetIndex": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set worksheet index(number) to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Index", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "WorksheetName": { "type": "string", "description": "Set worksheet name to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Name", "x-ca-group": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "ConvertMetadata": { "type": "boolean", "description": "Convert document metadata like Title, Author, Keywords to PDF metadata.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert metadata", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Page orientation.\n * `default` - Default\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "default", "letter", "lettersmall", "tabloid", "ledger", "legal", "statement", "executive", "a3", "a4", "a4small", "a5", "b4", "b5" ], "type": "string", "description": "Page size.\n * `default` - Default\n * `letter` - Letter\n * `lettersmall` - Letter Small\n * `tabloid` - Tabloid\n * `ledger` - Ledger\n * `legal` - Legal\n * `statement` - Statement\n * `executive` - Executive\n * `a3` - A3\n * `a4` - A4\n * `a4small` - A4 Small\n * `a5` - A5\n * `b4` - B4\n * `b5` - B5", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "letter": "Letter", "lettersmall": "Letter Small", "tabloid": "Tabloid", "ledger": "Ledger", "legal": "Legal", "statement": "Statement", "executive": "Executive", "a3": "A3", "a4": "A4", "a4small": "A4 Small", "a5": "A5", "b4": "B4", "b5": "B5" } }, "AutoColumnFit": { "type": "boolean", "description": "Auto fit columns to reduce unnecessary empty space in table.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Column Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AutoPageFit": { "type": "boolean", "description": "Automatically enlarges page size, switches to landscape when needed, trims margins, and finally scales the sheet to one-page width. If `PageSize` or `PageOrientation` are chosen, those choices are left unchanged.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Page Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ClearPrintArea": { "type": "boolean", "description": "Clear the print area in the converting document.", "default": false, "x-ca-featured": false, "x-ca-label": "Clear Print Area", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Set content scale value in percentage.", "x-ca-featured": false, "x-ca-label": "Scale Content", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "HeaderOnEachPage": { "type": "boolean", "description": "Ensures the header row is repeated on all pages when the sheet's content spans multiple pages in the PDF output. If a table is detected in the sheet, its header row is used; otherwise, the first row with data is treated as the header.", "default": false, "x-ca-featured": false, "x-ca-label": "Header on Each Page", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ThousandsSeparator": { "type": "string", "description": "Thousands separator.", "default": ",", "x-ca-featured": false, "x-ca-label": "Thousands separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DecimalSeparator": { "type": "string", "description": "Decimal separator.", "default": ".", "x-ca-featured": false, "x-ca-label": "Decimal separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DateFormat": { "enum": [ "us", "iso", "eu", "german", "japanese" ], "type": "string", "description": "Sets the date format for output document, overriding the default US locale (M/d/yyyy) to ensure consistency regardless of regional Excel settings.\n * `us` - US (M/d/yyyy)\n * `iso` - ISO (yyyy-MM-dd)\n * `eu` - EU (dd/MM/yyyy)\n * `german` - German (dd.MM.yyyy)\n * `japanese` - Japanese (yyyy/MM/dd)", "default": "us", "x-ca-featured": false, "x-ca-label": "Date Format", "x-ca-group": "Formatting Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "us": "US (M/d/yyyy)", "iso": "ISO (yyyy-MM-dd)", "eu": "EU (dd/MM/yyyy)", "german": "German (dd.MM.yyyy)", "japanese": "Japanese (yyyy/MM/dd)" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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 Excel XLSB workbooks to PDF for sharing, review, and archiving. Select the worksheet by name, index, or the active sheet, and open password‑protected files when required. Control page orientation and page size, auto‑fit by columns or pages, clear print areas, and apply custom scaling to match layout constraints. Add a header on each page and optionally preserve metadata. Normalize locale with thousands/decimal separators and date formats for consistent output. Enable PDF/A for long‑term preservation and process single files or batches with predictable results.", "x-ca-meta-title": "XLSB to PDF API – Convert Excel XLSB workbooks to PDF files", "x-ca-meta-description": "Convert XLSB workbooks to PDF. Select worksheet, control page size/orientation, auto‑fit and scaling, headers, locale formats, and PDF/A.", "x-ca-source-formats": "xlsb", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "spreadsheet", "office", "pdf" ] }, "/convert/xlsx/to/pdf": { "summary": "XLSX to PDF API", "description": "Convert XLS and XLSX workbooks to PDF. Choose worksheet, control page size/orientation, auto‑fit, scaling, headers, passwords, and PDF/A.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "xls", "xlsx" ] }, "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": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "WorksheetActive": { "type": "boolean", "description": "Set to convert active worksheet. If value is set False all worksheet will be converted.", "default": false, "x-ca-featured": false, "x-ca-label": "Worksheet Active", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "WorksheetIndex": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set worksheet index(number) to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Index", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "WorksheetName": { "type": "string", "description": "Set worksheet name to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Name", "x-ca-group": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "ConvertMetadata": { "type": "boolean", "description": "Convert document metadata like Title, Author, Keywords to PDF metadata.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert metadata", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Page orientation.\n * `default` - Default\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "default", "letter", "lettersmall", "tabloid", "ledger", "legal", "statement", "executive", "a3", "a4", "a4small", "a5", "b4", "b5" ], "type": "string", "description": "Page size.\n * `default` - Default\n * `letter` - Letter\n * `lettersmall` - Letter Small\n * `tabloid` - Tabloid\n * `ledger` - Ledger\n * `legal` - Legal\n * `statement` - Statement\n * `executive` - Executive\n * `a3` - A3\n * `a4` - A4\n * `a4small` - A4 Small\n * `a5` - A5\n * `b4` - B4\n * `b5` - B5", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "letter": "Letter", "lettersmall": "Letter Small", "tabloid": "Tabloid", "ledger": "Ledger", "legal": "Legal", "statement": "Statement", "executive": "Executive", "a3": "A3", "a4": "A4", "a4small": "A4 Small", "a5": "A5", "b4": "B4", "b5": "B5" } }, "AutoColumnFit": { "type": "boolean", "description": "Auto fit columns to reduce unnecessary empty space in table.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Column Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AutoPageFit": { "type": "boolean", "description": "Automatically enlarges page size, switches to landscape when needed, trims margins, and finally scales the sheet to one-page width. If `PageSize` or `PageOrientation` are chosen, those choices are left unchanged.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Page Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ClearPrintArea": { "type": "boolean", "description": "Clear the print area in the converting document.", "default": false, "x-ca-featured": false, "x-ca-label": "Clear Print Area", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Set content scale value in percentage.", "x-ca-featured": false, "x-ca-label": "Scale Content", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "HeaderOnEachPage": { "type": "boolean", "description": "Ensures the header row is repeated on all pages when the sheet's content spans multiple pages in the PDF output. If a table is detected in the sheet, its header row is used; otherwise, the first row with data is treated as the header.", "default": false, "x-ca-featured": false, "x-ca-label": "Header on Each Page", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ThousandsSeparator": { "type": "string", "description": "Thousands separator.", "default": ",", "x-ca-featured": false, "x-ca-label": "Thousands separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DecimalSeparator": { "type": "string", "description": "Decimal separator.", "default": ".", "x-ca-featured": false, "x-ca-label": "Decimal separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DateFormat": { "enum": [ "us", "iso", "eu", "german", "japanese" ], "type": "string", "description": "Sets the date format for output document, overriding the default US locale (M/d/yyyy) to ensure consistency regardless of regional Excel settings.\n * `us` - US (M/d/yyyy)\n * `iso` - ISO (yyyy-MM-dd)\n * `eu` - EU (dd/MM/yyyy)\n * `german` - German (dd.MM.yyyy)\n * `japanese` - Japanese (yyyy/MM/dd)", "default": "us", "x-ca-featured": false, "x-ca-label": "Date Format", "x-ca-group": "Formatting Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "us": "US (M/d/yyyy)", "iso": "ISO (yyyy-MM-dd)", "eu": "EU (dd/MM/yyyy)", "german": "German (dd.MM.yyyy)", "japanese": "Japanese (yyyy/MM/dd)" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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 Excel XLS/XLSX workbooks to PDF for sharing, review, and archiving. Select the worksheet by name, index, or the active sheet, and open password‑protected files when required. Control page orientation and page size, auto‑fit by columns or pages, clear print areas, and apply custom scaling to match layout constraints. Add a header on each page and optionally preserve metadata. Normalize locale with thousands/decimal separators and date formats for consistent output. Enable PDF/A for long‑term preservation and process single files or batches with predictable results.", "x-ca-meta-title": "XLSX to PDF API – Convert Excel XLS and XLSX to PDF", "x-ca-meta-description": "Convert XLS/XLSX workbooks to PDF. Select worksheet, control page size/orientation, auto‑fit and scaling, headers, locale formats, and PDF/A.", "x-ca-source-formats": "xls,xlsx", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "spreadsheet", "office", "pdf", "featured" ] }, "/convert/xltx/to/pdf": { "summary": "XLTX to PDF API", "description": "Convert Excel XLTX templates to PDF. Select worksheet, set page size/orientation, auto‑fit, scaling, headers, locale formats, and PDF/A.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "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" }, "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": [ "xltx" ] }, "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": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "WorksheetActive": { "type": "boolean", "description": "Set to convert active worksheet. If value is set False all worksheet will be converted.", "default": false, "x-ca-featured": false, "x-ca-label": "Worksheet Active", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "WorksheetIndex": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set worksheet index(number) to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Index", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "WorksheetName": { "type": "string", "description": "Set worksheet name to convert. If value is not set all worksheet will be converted.", "x-ca-featured": false, "x-ca-label": "Worksheet Name", "x-ca-group": "Excel", "x-ca-type": "String", "x-ca-representation": "Default" }, "ConvertMetadata": { "type": "boolean", "description": "Convert document metadata like Title, Author, Keywords to PDF metadata.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert metadata", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageOrientation": { "enum": [ "default", "portrait", "landscape" ], "type": "string", "description": "Page orientation.\n * `default` - Default\n * `portrait` - Portrait\n * `landscape` - Landscape", "default": "default", "x-ca-featured": false, "x-ca-label": "Page orientation", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "portrait": "Portrait", "landscape": "Landscape" } }, "PageSize": { "enum": [ "default", "letter", "lettersmall", "tabloid", "ledger", "legal", "statement", "executive", "a3", "a4", "a4small", "a5", "b4", "b5" ], "type": "string", "description": "Page size.\n * `default` - Default\n * `letter` - Letter\n * `lettersmall` - Letter Small\n * `tabloid` - Tabloid\n * `ledger` - Ledger\n * `legal` - Legal\n * `statement` - Statement\n * `executive` - Executive\n * `a3` - A3\n * `a4` - A4\n * `a4small` - A4 Small\n * `a5` - A5\n * `b4` - B4\n * `b5` - B5", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "letter": "Letter", "lettersmall": "Letter Small", "tabloid": "Tabloid", "ledger": "Ledger", "legal": "Legal", "statement": "Statement", "executive": "Executive", "a3": "A3", "a4": "A4", "a4small": "A4 Small", "a5": "A5", "b4": "B4", "b5": "B5" } }, "AutoColumnFit": { "type": "boolean", "description": "Auto fit columns to reduce unnecessary empty space in table.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Column Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AutoPageFit": { "type": "boolean", "description": "Automatically enlarges page size, switches to landscape when needed, trims margins, and finally scales the sheet to one-page width. If `PageSize` or `PageOrientation` are chosen, those choices are left unchanged.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Page Fit", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ClearPrintArea": { "type": "boolean", "description": "Clear the print area in the converting document.", "default": false, "x-ca-featured": false, "x-ca-label": "Clear Print Area", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Scale": { "maximum": 300, "minimum": 10, "type": "integer", "description": "Set content scale value in percentage.", "x-ca-featured": false, "x-ca-label": "Scale Content", "x-ca-group": "Excel", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "300" } }, "HeaderOnEachPage": { "type": "boolean", "description": "Ensures the header row is repeated on all pages when the sheet's content spans multiple pages in the PDF output. If a table is detected in the sheet, its header row is used; otherwise, the first row with data is treated as the header.", "default": false, "x-ca-featured": false, "x-ca-label": "Header on Each Page", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ThousandsSeparator": { "type": "string", "description": "Thousands separator.", "default": ",", "x-ca-featured": false, "x-ca-label": "Thousands separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DecimalSeparator": { "type": "string", "description": "Decimal separator.", "default": ".", "x-ca-featured": false, "x-ca-label": "Decimal separator", "x-ca-group": "Formatting Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "DateFormat": { "enum": [ "us", "iso", "eu", "german", "japanese" ], "type": "string", "description": "Sets the date format for output document, overriding the default US locale (M/d/yyyy) to ensure consistency regardless of regional Excel settings.\n * `us` - US (M/d/yyyy)\n * `iso` - ISO (yyyy-MM-dd)\n * `eu` - EU (dd/MM/yyyy)\n * `german` - German (dd.MM.yyyy)\n * `japanese` - Japanese (yyyy/MM/dd)", "default": "us", "x-ca-featured": false, "x-ca-label": "Date Format", "x-ca-group": "Formatting Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "us": "US (M/d/yyyy)", "iso": "ISO (yyyy-MM-dd)", "eu": "EU (dd/MM/yyyy)", "german": "German (dd.MM.yyyy)", "japanese": "Japanese (yyyy/MM/dd)" } }, "Pdfa": { "type": "boolean", "description": "Create PDF/A-1b compliant document.", "default": false, "x-ca-featured": false, "x-ca-label": "Create PDF/A", "x-ca-group": "PDF 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 Excel XLTX templates to polished PDF documents for distribution and archiving. Select the worksheet by name, index, or the active sheet, and open password‑protected inputs if necessary. Control page orientation and page size, auto‑fit by columns or pages, clear print areas, and apply custom scaling to meet layout constraints. Add a header on each page and optionally preserve metadata. Normalize locale with thousands/decimal separators and date formats for consistent presentation across regions. Enable PDF/A for long‑term preservation and process single files or batches to achieve predictable, repeatable results.", "x-ca-meta-title": "XLTX to PDF API – Convert Excel template files to PDF", "x-ca-meta-description": "Convert XLTX to PDF. Select worksheet, control page size/orientation, auto‑fit and scaling, headers, locale formats, metadata, and PDF/A.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "spreadsheet", "office", "pdf" ] } }, "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" } }