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" } } } } } }, "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": "DOCX Template API is a tool that allows you to dynamically generate MS Word documents by replacing custom properties using a JSON object that contains your data. It's a game changer for anyone who works with Word documents frequently and wants to streamline their workflow. Using our DOCX Template API, you can effortlessly create stunning MS Word documents. It is super helpful for automatic invoice generation, dynamic proposal, or quote creation using your desired DOCX template as a basis for the final document.", "x-ca-meta-title": "DOCX template API: Generate dynamic MS Word documents using JSON - ConvertAPI", "x-ca-meta-description": "DOCX Template API is a tool that allows you to dynamically inject or replace custom document properties within an MS Word template by passing a JSON object that contains your data.", "x-ca-source-formats": "docx,dotx", "x-ca-destination-formats": "docx", "x-ca-tags": [ "office", "document", "template" ] }, "/convert/template/to/pdf": { "summary": "PDF Template API", "description": "Generate dynamic PDF documents from a DOCX template and JSON data, enabling automated report generation and document creation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/template-to-pdf" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "JsonPayload" ], "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": [ "docx", "dotx" ] }, "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" } }, "JsonPayload": { "type": "string", "description": "**Property Fields example:**\r\n\r\nJSON object containing values to be inserted into the **document's custom properties fields**.\r\n\r\n```json\r\n[\r\n {\r\n \"Name\": \"ProductName\",\r\n \"Value\": \"Acme Product\",\r\n \"Type\": \"string\"\r\n },\r\n {\r\n \"Name\": \"Price\",\r\n \"Value\": \"99.50 USD\",\r\n \"Type\": \"string\"\r\n },\r\n {\r\n \"Name\": \"Quantity\",\r\n \"Value\": 10,\r\n \"Type\": \"integer\"\r\n },\r\n {\r\n \"Name\": \"OrderDate\",\r\n \"Value\": \"2011-11-11\",\r\n \"Type\": \"datetime\"\r\n },\r\n {\r\n \"Name\": \"Paid\",\r\n \"Value\": true,\r\n \"Type\": \"boolean\"\r\n }\r\n]\r\n```\r\n\r\n**Placeholders example:**\r\n\r\nJSON object containing values to be inserted into the **document's placeholders**.\r\n```json\r\n[\r\n {\r\n \"Name\": \"name\",\r\n \"Value\": \"John\",\r\n \"Type\": \"string\"\r\n },\r\n {\r\n \"Name\": \"myImage\",\r\n \"ImageWidth\": 200,\r\n \"imageHeight\": 100,\r\n \"Value\": \"/9j/4AAQS...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/jpg": { "summary": "TIFF to JPG API", "description": "Convert TIFF images to JPG and replace transparency with a chosen color. Control color space, JPEG quality, resolution, scaling, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-jpg" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AlphaColor": { "type": "string", "description": "Set a color on the alpha (transparent) channel. Values accepted are RGBA, CMYK hex string, or a color name.", "x-ca-featured": false, "x-ca-label": "Alpha channel color", "x-ca-group": "Image", "x-ca-type": "Color", "x-ca-representation": "Default" }, "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": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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 TIFF images to JPG while handling alpha transparency that JPEG does not support. Replace transparent regions with a specified background color so assets render consistently across light and dark themes. Use general image controls to set resolution (DPI), scaling behavior, and explicit width/height to produce predictable outputs across inputs. Choose color space for device consistency and tune JPEG quality to balance clarity with compact file size. Ideal for preparing scans and raster graphics for websites, apps, and systems that require opaque JPEG images.", "x-ca-meta-title": "TIFF to JPG Conversion API – Replace alpha with color.", "x-ca-meta-description": "Convert TIFF to JPG via API. Replace transparent areas with a chosen color and control color space, JPEG quality, resolution, scaling, and size.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "image" ] }, "/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/tiff/to/png": { "summary": "TIFF to PNG API", "description": "Convert TIFF images to PNG for web and apps. Control transparency mapping, color space, resolution (DPI), scaling behavior, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-png" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "PNG Output", "x-ca-type": "String", "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 TIFF images to widely supported PNG format for web, mobile, and general application use. Use general image controls to adjust resolution (DPI), scaling behavior, and explicit width/height to achieve consistent output across varied inputs. Map a specific color to transparency when needed to preserve foreground elements over UI backgrounds, and tune color space for predictable rendering. Ideal for preparing documents and scans for distribution or UI display where lossless compression and alpha transparency are beneficial.", "x-ca-meta-title": "TIFF to PNG Conversion API – Convert TIFF to PNG.", "x-ca-meta-description": "Convert TIFF to PNG via API. Map a color to transparency and control color space, resolution, scaling, and dimensions for predictable results.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "png", "x-ca-tags": [ "image" ] }, "/convert/tiff/to/pnm": { "summary": "TIFF to PNM API", "description": "Convert TIFF images to PNM (PBM/PGM/PPM). Control resolution (DPI), scaling behavior, exact size, color handling, and transparency mapping.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-pnm" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "PNG Output", "x-ca-type": "String", "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 TIFF images to Portable Any Map (PNM) formats for simple, interoperable raster output (PBM/PGM/PPM). Use general image controls to set resolution (DPI), select scaling behavior, and define exact width/height for predictable results across inputs. Choose grayscale or RGB output as appropriate, and map transparent regions to a specified background color when downstream tools lack alpha support. Ideal for processing pipelines, testing, and archival workflows that require lightweight, uncompressed files with consistent characteristics.", "x-ca-meta-title": "TIFF to PNM Conversion API – Portable Any Map output.", "x-ca-meta-description": "Convert TIFF to PNM via API. Control resolution, scaling, dimensions, color handling, and transparency mapping for PBM/PGM/PPM output.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "pnm", "x-ca-tags": [ "image" ] }, "/convert/tiff/to/svg": { "summary": "TIFF to SVG API", "description": "Convert TIFF images to precise SVG vectors with controls for color mode, layering, curve fitting, corners, speckle filtering, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-svg" }, "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" } }, "Preset": { "enum": [ "none", "detailed", "crisp", "graphic", "illustration", "noisyScan" ], "type": "string", "description": "\n * `none` - None\n * `detailed` - High Detail Precision\n * `crisp` - Sharp Edges and Lines\n * `graphic` - Complex Graphic Elements\n * `illustration` - Illustration\n * `noisyScan` - Noisy Scan", "default": "none", "x-ca-featured": true, "x-ca-label": "Preset", "x-ca-group": "Vectorize", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "detailed": "High Detail Precision", "crisp": "Sharp Edges and Lines", "graphic": "Complex Graphic Elements", "illustration": "Illustration", "noisyScan": "Noisy Scan" } }, "ColorMode": { "enum": [ "color", "bw" ], "type": "string", "description": "Determines whether the image is traced in black-and-white or in full color.\n * `color` - Color\n * `bw` - Black and White", "default": "color", "x-ca-featured": false, "x-ca-label": "Color Mode", "x-ca-group": "Vectorize", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color": "Color", "bw": "Black and White" } }, "Layering": { "enum": [ "cutout", "stacked" ], "type": "string", "description": "Defines how color regions are arranged in the output SVG-either as cut-out layers or stacked overlays.\n * `cutout` - Cutout\n * `stacked` - Stacked", "default": "stacked", "x-ca-featured": false, "x-ca-label": "Layering", "x-ca-group": "Vectorize", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "cutout": "Cutout", "stacked": "Stacked" } }, "FilterSpeckle": { "maximum": 128, "minimum": 0, "type": "integer", "description": "Removes small isolated regions during tracing.", "default": 4, "x-ca-featured": false, "x-ca-label": "Filter Speckle", "x-ca-group": "Vectorize", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "128" } }, "ColorPrecision": { "maximum": 8, "minimum": 1, "type": "integer", "description": "Sets the quantization level for color reduction.", "default": 6, "x-ca-featured": false, "x-ca-label": "Color Precision", "x-ca-group": "Vectorize", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "8" } }, "GradientStep": { "maximum": 128, "minimum": 0, "type": "integer", "description": "Controls how gradient transitions are divided into color steps.", "default": 10, "x-ca-featured": false, "x-ca-label": "Gradient Step", "x-ca-group": "Vectorize", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "128" } }, "CurveMode": { "enum": [ "pixel", "polygon", "spline" ], "type": "string", "description": "\n * `pixel` - Pixel\n * `polygon` - Polygon\n * `spline` - Spline", "default": "spline", "x-ca-featured": false, "x-ca-label": "Curve Mode", "x-ca-group": "Vectorize", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pixel": "Pixel", "polygon": "Polygon", "spline": "Spline" } }, "CornerThreshold": { "maximum": 180, "minimum": 0, "type": "integer", "description": "Determines sensitivity for detecting corners versus smooth curves. Effective only when `CurveMode` is set to **Spline**.", "default": 55, "x-ca-featured": false, "x-ca-label": "Corner Threshold", "x-ca-group": "Vectorize", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "180" } }, "SegmentLength": { "maximum": 10, "minimum": 3.5, "type": "number", "description": "Sets the average length of path segments. Effective only when `CurveMode` is set to **Spline**.", "default": 4, "x-ca-featured": false, "x-ca-label": "Segment Length", "x-ca-group": "Vectorize", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "3.5", "to": "10" } }, "SpliceThreshold": { "maximum": 180, "minimum": 0, "type": "integer", "description": "Defines the threshold for merging adjacent short path segments into longer ones. Effective only when `CurveMode` is set to **Spline**.", "default": 35, "x-ca-featured": false, "x-ca-label": "Splice Threshold", "x-ca-group": "Vectorize", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "180" } }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } } } } } } }, "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 TIFF images into precise, scalable SVG vectors. Adjust color mode and palette size, layering, curve fitting, corner threshold, segment length, speckle filtering, and gradient steps to match your quality and size goals. Optionally fix output width/height for consistent results across files. Ideal for diagrams, scans, and vectorizing raster artwork.", "x-ca-meta-title": "TIFF to SVG Conversion API – Vectorize TIFF to SVG.", "x-ca-meta-description": "Convert TIFF to SVG via API. Control colors, layers, curves, corners, speckle filtering, and size for crisp, lightweight vectors.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "svg", "x-ca-tags": [ "image" ] }, "/convert/tiff/to/tiff": { "summary": "TIFF to TIFF API", "description": "Re‑encode TIFF images for archiving and print. Control multipage, color space, quality, resolution (DPI), scaling behavior, and dimensions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-tiff" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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": "Optimize or normalize existing TIFF images while preserving high fidelity for archiving, print workflows, and interoperability. Choose single‑ or multi‑page output to consolidate sequences, adjust color space for device consistency, and fine‑tune compression/quality for the target use case. Set resolution (DPI), scaling behavior, and explicit width/height to meet layout or storage constraints. Ideal for records retention, pre‑press pipelines, and systems that require predictable TIFF output.", "x-ca-meta-title": "TIFF to TIFF Conversion API – Optimize TIFF files.", "x-ca-meta-description": "Re‑encode TIFF via API. Control multipage, color space, quality, resolution, scaling, and dimensions for predictable, high‑fidelity output.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "image" ] }, "/convert/tiff/to/webp": { "summary": "TIFF to WebP API", "description": "Convert TIFF images to WebP. Choose lossless/lossy, set quality, color space, resolution (DPI), scaling behavior, and dimensions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/tiff-to-webp" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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": "WebP Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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 TIFF images to modern WebP to reduce file sizes while preserving high visual fidelity. Set resolution (DPI), choose scaling behavior, and define explicit width/height so outputs match UI layouts or storage constraints. Select lossless or lossy compression and adjust the quality factor to balance clarity and size, and choose an appropriate color space for consistent rendering across platforms. Ideal for web and mobile delivery, batch optimization pipelines, and CDN workflows where small, visually faithful images are desired.", "x-ca-meta-title": "TIFF to WebP Conversion API – Convert TIFF to WebP.", "x-ca-meta-description": "Convert TIFF to WebP via API. Choose lossless/lossy, set quality, color space, resolution, scaling, and dimensions for optimized delivery.", "x-ca-source-formats": "tif,tiff", "x-ca-destination-formats": "webp", "x-ca-tags": [ "image" ] }, "/convert/txt/to/jpg": { "summary": "TXT to JPG", "description": "The API for converting Word documents to JPG images.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/txt-to-jpg" }, "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": [ "docx", "doc", "dot", "dotx", "rtf", "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" } }, "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-2000", "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ImageHeight": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageWidth": { "maximum": 10000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "10000" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The API for converting Word {0} documents to {1} images.", "x-ca-meta-title": null, "x-ca-meta-description": null, "x-ca-source-formats": "docx,doc,dot,dotx,rtf,txt", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "document", "office", "image" ] }, "/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/jpg": { "summary": "Visio to JPG API", "description": "Convert Microsoft Visio VSD and VSDX diagrams to JPG images with high quality, ensuring layout preservation and sharp details.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/vsdx-to-jpg" }, "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" }, "JpgType": { "enum": [ "jpeg", "jpegcmyk", "jpeggray" ], "type": "string", "description": "Set JPG type.\n * `jpeg` - RGB (Full Colors)\n * `jpegcmyk` - CMYK\n * `jpeggray` - Grayscale", "default": "jpeg", "x-ca-featured": false, "x-ca-label": "JPG Type", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "jpeg": "RGB (Full Colors)", "jpegcmyk": "CMYK", "jpeggray": "Grayscale" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Visio VSD/VSDX diagrams to high-quality JPG images. Choose resolution, width/height, and JPEG quality. Preserves page layout and renders shapes, text, layers, and connectors clearly for sharing, previewing, or embedding.", "x-ca-meta-title": "Visio to JPG Conversion API – Diagrams to Images", "x-ca-meta-description": "Convert Visio VSD/VSDX to JPG via API. Control resolution and quality. Shareable images for reports, wikis, and previews.", "x-ca-source-formats": "vsd,vsdx", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "drawing", "office", "image" ] }, "/convert/vsdx/to/pdf": { "summary": "Visio 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/vsdx/to/png": { "summary": "Visio to PNG API", "description": "Convert Microsoft Visio VSD and VSDX diagrams to PNG images with transparency support, high resolution and pixel-perfect output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/vsdx-to-png" }, "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" }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Visio VSD/VSDX diagrams to crisp PNG images for use in reports, wikis, and apps. Control resolution and output size for pixel‑perfect exports. Ideal when you need lossless, widely supported raster images.", "x-ca-meta-title": "Visio to PNG Conversion API – Diagrams to Images", "x-ca-meta-description": "Convert Visio VSD/VSDX to PNG via API. Control resolution and size for clear, lossless images in docs and dashboards.", "x-ca-source-formats": "vsd,vsdx", "x-ca-destination-formats": "png", "x-ca-tags": [ "drawing", "office", "image" ] }, "/convert/vsdx/to/tiff": { "summary": "Visio to TIFF API", "description": "Convert Microsoft Visio VSD and VSDX diagrams to TIFF images suitable for printing, with multi-page support and high resolution.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/vsdx-to-tiff" }, "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" }, "TiffType": { "enum": [ "color24nc", "color32nc", "color24lzw", "color32lzw", "color24zip", "color32zip", "grayscale", "grayscalelzw", "grayscalezip", "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF type.\n * `color24nc` - Color - 24bits RGB output, uncompressed\n * `color32nc` - Color - 32bits CMYK output, uncompressed\n * `color24lzw` - Color - 24bits RGB, LZW-compatible compression\n * `color32lzw` - Color - 32bits CMYK, LZW-compatible compression\n * `color24zip` - Color - 24bits RGB, ZIP (Deflate) compression\n * `color32zip` - Color - 32bits CMYK, ZIP (Deflate) compression\n * `grayscale` - Grayscale - 8bits output, uncompressed\n * `grayscalelzw` - Grayscale - 8bits output, LZW-compatible compression\n * `grayscalezip` - Grayscale - 8bits output, ZIP (Deflate) compression\n * `monochromeg3` - Monochrome - G3 fax encoding with EOLs\n * `monochromeg32d` - Monochrome - 2-D G3 fax encoding\n * `monochromeg4` - Monochrome - G4 fax encoding\n * `monochromelzw` - Monochrome - LZW-compatible compression\n * `monochromepackbits` - Monochrome - PackBits compression", "default": "color24lzw", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color24nc": "Color - 24bits RGB output, uncompressed", "color32nc": "Color - 32bits CMYK output, uncompressed", "color24lzw": "Color - 24bits RGB, LZW-compatible compression", "color32lzw": "Color - 32bits CMYK, LZW-compatible compression", "color24zip": "Color - 24bits RGB, ZIP (Deflate) compression", "color32zip": "Color - 32bits CMYK, ZIP (Deflate) compression", "grayscale": "Grayscale - 8bits output, uncompressed", "grayscalelzw": "Grayscale - 8bits output, LZW-compatible compression", "grayscalezip": "Grayscale - 8bits output, ZIP (Deflate) compression", "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillOrder": { "enum": [ "0", "1" ], "type": "string", "description": "The logical order of bits within a byte.\n * `0` - MSB-to-LSB\n * `1` - LSB-to-MSB", "default": "0", "x-ca-featured": false, "x-ca-label": "Fill order", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "MSB-to-LSB", "1": "LSB-to-MSB" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Visio VSD/VSDX diagrams to high‑fidelity TIFF images suitable for print and archival workflows. Control resolution, color settings, and page rendering to preserve precise layout, shapes, and annotations.", "x-ca-meta-title": "Visio to TIFF Conversion API – Print‑Ready Exports", "x-ca-meta-description": "Convert Visio VSD/VSDX to TIFF via API. High‑quality, print‑ready images with controllable resolution and color settings.", "x-ca-source-formats": "vsd,vsdx", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "drawing", "office", "image" ] }, "/convert/web/to/jpg": { "summary": "Web to JPG API", "description": "Capture live web pages to JPG images with quality and sizing controls", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/web-to-jpg" }, "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" }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "CropElement": { "type": "string", "description": "Element selector string of the DOM element that should be converted. Element will be cropped from the document.", "x-ca-featured": false, "x-ca-label": "Crop DOM element", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "CropX": { "maximum": 16384, "minimum": 0, "type": "integer", "description": "Screenshot crop X offset.", "x-ca-featured": false, "x-ca-label": "Crop X offset", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "16384" } }, "CropY": { "maximum": 16384, "minimum": 0, "type": "integer", "description": "Screenshot crop Y offset.", "x-ca-featured": false, "x-ca-label": "Crop Y offset", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "16384" } }, "CropWidth": { "maximum": 16384, "minimum": 1, "type": "integer", "description": "Screenshot crop width.", "x-ca-featured": false, "x-ca-label": "Crop width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "16384" } }, "CropHeight": { "maximum": 16384, "minimum": 1, "type": "integer", "description": "Screenshot crop height.", "x-ca-featured": false, "x-ca-label": "Crop height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "16384" } }, "Zoom": { "maximum": 10, "minimum": 0.1, "type": "number", "description": "Set the default zoom level of webpages.", "default": 1, "x-ca-featured": false, "x-ca-label": "Zoom", "x-ca-group": "Web Rendering", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.1", "to": "10" } }, "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": "Convert websites (URL input) to JPG screenshots using a modern headless browser renderer. Control image width/height, JPEG quality, zoom level, and crop by CSS selector or coordinates for pixel‑accurate results. Customize loading with timeouts, delays, and wait‑for‑element; run page JavaScript; inject custom CSS/JS; block ads and cookie banners; hide elements; and set headers, cookies, and basic auth to access gated content. Perfect for thumbnails, previews, reporting, and archiving consistent page renders.", "x-ca-meta-title": "Web to JPG Conversion API – Website Screenshots", "x-ca-meta-description": "Convert web pages to JPG via API. Control size, quality, crop, zoom, waits, JS/CSS, headers, cookies, and auth for accurate captures.", "x-ca-source-formats": "web", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "html", "image" ] }, "/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/web/to/png": { "summary": "Web to PNG API", "description": "Capture live web pages to PNG images with sizing, crop, and transparency controls", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/web-to-png" }, "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" }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "CropElement": { "type": "string", "description": "Element selector string of the DOM element that should be converted. Element will be cropped from the document.", "x-ca-featured": false, "x-ca-label": "Crop DOM element", "x-ca-group": "Web Rendering", "x-ca-type": "String", "x-ca-representation": "Default" }, "CropX": { "maximum": 16384, "minimum": 0, "type": "integer", "description": "Screenshot crop X offset.", "x-ca-featured": false, "x-ca-label": "Crop X offset", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "16384" } }, "CropY": { "maximum": 16384, "minimum": 0, "type": "integer", "description": "Screenshot crop Y offset.", "x-ca-featured": false, "x-ca-label": "Crop Y offset", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "16384" } }, "CropWidth": { "maximum": 16384, "minimum": 1, "type": "integer", "description": "Screenshot crop width.", "x-ca-featured": false, "x-ca-label": "Crop width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "16384" } }, "CropHeight": { "maximum": 16384, "minimum": 1, "type": "integer", "description": "Screenshot crop height.", "x-ca-featured": false, "x-ca-label": "Crop height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "16384" } }, "Zoom": { "maximum": 10, "minimum": 0.1, "type": "number", "description": "Set the default zoom level of webpages.", "default": 1, "x-ca-featured": false, "x-ca-label": "Zoom", "x-ca-group": "Web Rendering", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.1", "to": "10" } }, "TransparentBackground": { "type": "boolean", "description": "Sets default background color to transparent to get transparency in the image. Also, for this property to work, the source HTML BODY background color should be set to none.", "default": false, "x-ca-featured": false, "x-ca-label": "Transparent background", "x-ca-group": "Web Rendering", "x-ca-type": "Bool", "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": "Convert websites (URL input) to PNG screenshots using a modern headless browser renderer. Control output width/height, zoom level, and crop by CSS selector or coordinates; optionally enable a transparent background for overlays. Handle dynamic pages by running JavaScript, waiting for a selector, and injecting custom CSS/JS. Access gated content with headers, cookies, and basic auth; block ads and cookie banners; hide elements; and adjust timeouts/delays for reliable rendering. Ideal for crisp, lossless previews, documentation, dashboards, and reports.", "x-ca-meta-title": "Web to PNG Conversion API – Website Screenshots", "x-ca-meta-description": "Convert web pages to PNG via API. Control size, crop, zoom, and transparency with waits, JS/CSS, headers, cookies, and auth.", "x-ca-source-formats": "web", "x-ca-destination-formats": "png", "x-ca-tags": [ "html", "image" ] }, "/convert/web/to/txt": { "summary": "Web to TXT API", "description": "Extract clean text from live web pages with selector filtering", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/web-to-txt" }, "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" }, "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" }, "ExtractElements": { "type": "string", "description": "Specifies a CSS selector to identify and extract specific DOM elements from the page, \r\ninstead of scraping the entire content, allowing for more targeted and efficient data retrieval; \r\nfor example, to select elements by class name use `.class-name`, to select an element by its ID use `#elementId`, \r\nor to select elements by their tag name use `tagName`.", "x-ca-featured": false, "x-ca-label": "Extract Elements", "x-ca-group": "Web Rendering", "x-ca-type": "String", "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": "Extract UTF‑8 plain text from websites (URL input) using a modern headless renderer. Execute page JavaScript and wait for a CSS selector so dynamic content is fully loaded. Limit extraction to specific elements with selectors, inject custom CSS/JS, hide elements, and block ads or cookie consent banners. Send custom headers and cookies or use basic auth for gated pages; adjust timeouts and delays for reliability. Ideal for indexing, ETL, and analytics.", "x-ca-meta-title": "Web to TXT Conversion API – Extract Plain Text", "x-ca-meta-description": "Extract plain text from web pages via API. UTF‑8 output with selector filtering, waits, JS/CSS injection, headers, cookies, and auth.", "x-ca-source-formats": "web", "x-ca-destination-formats": "txt", "x-ca-tags": [ "html", "extract" ] }, "/convert/webp/to/gif": { "summary": "WebP to GIF API", "description": "Convert WebP images to GIF, including animations. Control frame persistence, delay, iterations, colors, dimensions, and quality.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-gif" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Files" ], "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" }, "Files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Files to be converted. Value can be URL or file content. If used in query or multipart content parameter must be suffixed with index e.g. Files[0], Files[1], Files[2]...", "x-ca-featured": true, "x-ca-label": "Files", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PersistAnimation": { "type": "boolean", "description": "Read animation values AnimationIterations and AnimationDelay from GIF file. Only works if GIF file is added to file list.", "default": true, "x-ca-featured": false, "x-ca-label": "Read animation values", "x-ca-group": "Gif Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AnimationDelay": { "maximum": 20000, "minimum": 0, "type": "integer", "description": "Delay time, in 1/100 of a second, before displaying the next frame in an animated sequence. Default is 100 (1 second).", "default": 100, "x-ca-featured": false, "x-ca-label": "Animation delay", "x-ca-group": "Gif Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "20000" } }, "AnimationIterations": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "Set the number of iterations to loop an animation. Zero is infinity.", "default": 0, "x-ca-featured": false, "x-ca-label": "Animation iterations", "x-ca-group": "Gif Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } } } } } } }, "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 GIF, including animated GIF output when multiple frames are present. Fine‑tune playback with frame persistence (keep last frame), per‑frame delay, and total animation iterations to meet UX or platform guidelines. Use general image controls to set resolution (DPI), scaling behavior, and explicit width/height for consistent rendering across devices. Adjust color handling to balance palette size and visual fidelity while keeping file size small. Ideal for UI previews, messaging, and web delivery where broad GIF support is required.", "x-ca-meta-title": "WebP to GIF Conversion API – Animated GIF output.", "x-ca-meta-description": "Convert WebP to GIF via API. Create animated GIFs and control frame persistence, delay, iterations, colors, size, and quality.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "gif", "x-ca-tags": [ "image" ] }, "/convert/webp/to/jpg": { "summary": "WebP to JPG API", "description": "Convert WebP images to JPG and replace transparency with a chosen color. Control color space, JPEG quality, resolution, scaling, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-jpg" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AlphaColor": { "type": "string", "description": "Set a color on the alpha (transparent) channel. Values accepted are RGBA, CMYK hex string, or a color name.", "x-ca-featured": false, "x-ca-label": "Alpha channel color", "x-ca-group": "Image", "x-ca-type": "Color", "x-ca-representation": "Default" }, "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": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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 JPG while handling alpha transparency that JPEG does not support. Replace transparent regions with a specified background color so visuals look correct on light or dark backgrounds. Use general image controls to set resolution (DPI), scaling behavior, and explicit width/height for predictable output across inputs. Choose color space for device consistency and adjust JPEG quality to balance visual clarity and file size. Ideal for preparing assets for web, mobile, and email where opaque JPEGs with uniform backgrounds are required.", "x-ca-meta-title": "WebP to JPG Conversion API – Replace alpha with color.", "x-ca-meta-description": "Convert WebP to JPG via API. Replace transparent areas with a chosen color and control color space, JPEG quality, resolution, scaling, and size.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "image" ] }, "/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/webp/to/png": { "summary": "WebP to PNG API", "description": "Convert WebP images to PNG for web and apps. Map a color to transparency, set color space, resolution (DPI), scaling, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-png" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "PNG Output", "x-ca-type": "String", "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 widely supported PNG format for web, mobile, and application use. Use general image controls to adjust resolution (DPI), choose scaling behavior, and specify explicit width/height to achieve consistent output across varied inputs. Map a specific color to transparency when needed to preserve foreground elements over UI backgrounds, and set color space for predictable rendering across devices. Ideal for preparing assets for distribution or UI display where lossless compression and alpha transparency are beneficial.", "x-ca-meta-title": "WebP to PNG Conversion API – Convert WebP to PNG.", "x-ca-meta-description": "Convert WebP to PNG via API. Map a color to transparency and control color space, resolution (DPI), scaling, and dimensions.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "png", "x-ca-tags": [ "image" ] }, "/convert/webp/to/pnm": { "summary": "WebP to PNM API", "description": "Convert WebP images to Portable Any Map (PNM). Control color space, resolution, scaling, dimensions, and transparency mapping.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-pnm" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TransparentColor": { "type": "string", "description": "Add alpha channel to image, setting pixels matching color to transparent. Values accepted are RGBA, CMYK hex string, color name or RGB format like this 255,255,255 (RED=255, GREEN=255, BLUE=255) or 255,255,255,150 with alpha chanel.", "x-ca-featured": false, "x-ca-label": "Transparent Color", "x-ca-group": "PNG Output", "x-ca-type": "String", "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 Portable Any Map (PNM) formats for simple, interoperable raster output (PBM/PGM/PPM). Tune general image controls including resolution (DPI), scaling behavior, and explicit width/height to produce predictable results across inputs. Adjust color handling for accurate grayscale or RGB output and map transparent regions to a specified color when needed for downstream systems. Ideal for pipelines that require lightweight, uncompressed image representations for processing, testing, or archival workflows.", "x-ca-meta-title": "WebP to PNM Conversion API – Create Portable Any Map files.", "x-ca-meta-description": "Convert WebP to PNM via API. Control color space, resolution, scaling, dimensions, and transparency mapping for PBM/PGM/PPM output.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "pnm", "x-ca-tags": [ "image" ] }, "/convert/webp/to/svg": { "summary": "WebP to SVG API", "description": "Convert WebP images to SVG vectors with controls for color mode, layering, curve fitting, corners, speckle filtering, and output size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-svg" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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": "Svg Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "Svg Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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": "Vectorize WebP images into clean, scalable SVG graphics suitable for UI, diagrams, and icons. Adjust color mode and palette precision, choose layering strategies, and fine‑tune curve fitting, corner thresholds, segment lengths, and speckle filtering to balance visual fidelity against file size. Control gradient handling and set explicit width/height for consistent exports across batches. Ideal for converting raster assets into lightweight vectors that remain sharp at any scale and are easy to style or animate in modern workflows.", "x-ca-meta-title": "WebP to SVG Conversion API – Convert WebP to SVG.", "x-ca-meta-description": "Convert WebP to SVG via API. Control colors, layers, curves, corners, speckle filtering, and size for crisp, lightweight vectors.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "svg", "x-ca-tags": [ "image" ] }, "/convert/webp/to/tiff": { "summary": "WebP to TIFF API", "description": "Convert WebP images to TIFF for archiving and print. Control multipage output, color space, quality, resolution, scaling, and size.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-tiff" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "TIFF Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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 modern WebP images to robust TIFF format suitable for long‑term archiving, print workflows, and interoperability. Choose single‑ or multi‑page output to consolidate sequences, adjust color space for device consistency, and fine‑tune quality settings for the target use case. Set resolution (DPI), scaling behavior, and explicit width/height to meet layout or storage constraints. Ideal for records retention, pre‑press pipelines, and integrations that require lossless or high‑fidelity raster output with predictable characteristics.", "x-ca-meta-title": "WebP to TIFF Conversion API – Convert WebP to TIFF.", "x-ca-meta-description": "Convert WebP to TIFF via API. Control multipage, color space, quality, resolution, scaling, and size for archival and print‑ready output.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "image" ] }, "/convert/webp/to/webp": { "summary": "WebP to WebP API", "description": "Re‑encode WebP images to optimize size and quality. Control lossless/lossy mode, quality, color space, resolution, scaling, and dimensions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/webp-to-webp" }, "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" } }, "ImageResolution": { "maximum": 800, "minimum": 10, "type": "integer", "description": "Set output image resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "800" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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": "WebP Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "rgb": "RGB", "srgb": "sRGB", "cmyk": "CMYK", "gray": "Gray" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } } } } } } }, "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": "Optimize existing WebP images by re‑encoding them with precise control over output characteristics. Choose lossless or lossy mode and set the quality factor to balance clarity against file size. Adjust color space for consistent rendering across platforms and fine‑tune resolution, scaling behavior, and explicit width/height to match UI, delivery, or storage constraints. Ideal for batch optimization pipelines, CDN workflows, and preparing assets for web and mobile where small, visually faithful files are critical.", "x-ca-meta-title": "WebP to WebP Conversion API – Optimize WebP files.", "x-ca-meta-description": "Re‑encode WebP via API. Control lossless/lossy mode, quality, color space, resolution, scaling, and size to optimize delivery.", "x-ca-source-formats": "webp", "x-ca-destination-formats": "webp", "x-ca-tags": [ "image" ] }, "/convert/wpd/to/pdf": { "summary": "WPD to PDF", "description": "The API for converting Word documents to PDF files.", "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": [ "dot", "dotx", "wpd", "rtf", "log" ] }, "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": "The API for converting Word {0} documents to {1} files.", "x-ca-meta-title": null, "x-ca-meta-description": null, "x-ca-source-formats": "dot,dotx,wpd,rtf,log", "x-ca-destination-formats": "pdf", "x-ca-tags": [ "document", "office", "pdf" ] }, "/convert/xls/to/csv": { "summary": "XLS to CSV API", "description": "Export XLS worksheets to CSV files. Select sheets by name or index, open password‑protected workbooks, and generate clean, ready‑to‑parse data.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-csv" }, "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" ] }, "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": { "type": "string", "description": "Set one or several worksheet indexes(number) separated by comma 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": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "20000" } }, "WorksheetName": { "type": "string", "description": "Set one or several worksheet names separated by comma 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" } } } } } }, "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 workbooks to CSV for ingestion by downstream systems and scripts. Choose which worksheets to export using active sheet, index ranges, or name ranges, and process password‑protected files when necessary. Produce clean, line‑delimited output suited for data pipelines, analytics, and archival. Designed for automation, the converter handles single files or batches consistently so results remain predictable across environments and input variations.", "x-ca-meta-title": "XLS to CSV Conversion API – Export worksheets to CSV.", "x-ca-meta-description": "Export XLS to CSV via API. Select worksheets by name or index, handle passwords, and produce clean, ready‑to‑parse CSV output.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "csv", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xls/to/jpg": { "summary": "XLS to JPG API", "description": "Render XLS worksheets to JPG images for sharing and review. Select sheet, set DPI and size, tune JPEG quality, and scale to fit pages.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-jpg" }, "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" ] }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "JpgType": { "enum": [ "jpeg", "jpegcmyk", "jpeggray" ], "type": "string", "description": "Set JPG type.\n * `jpeg` - RGB (Full Colors)\n * `jpegcmyk` - CMYK\n * `jpeggray` - Grayscale", "default": "jpeg", "x-ca-featured": false, "x-ca-label": "JPG Type", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "jpeg": "RGB (Full Colors)", "jpegcmyk": "CMYK", "jpeggray": "Grayscale" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLS worksheets to JPG images for preview, sharing, and archival. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Use JPEG quality options to balance clarity and file size, and auto‑fit columns or pages via model parameters. Ideal for automation and batch processing where consistent visual outputs from spreadsheets are required across environments.", "x-ca-meta-title": "XLS to JPG Conversion API – Excel to JPG images.", "x-ca-meta-description": "Convert XLS to JPG via API. Choose worksheet, set DPI and dimensions, scale to fit pages, and tune JPEG quality for efficient delivery.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xls/to/png": { "summary": "XLS to PNG API", "description": "Render XLS worksheets to PNG images for sharing and archiving. Select sheet, set DPI and size, and scale to fit pages for consistent output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-png" }, "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" ] }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLS worksheets to PNG images for preview, sharing, and long‑term archiving. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Auto‑fit columns or pages via model parameters and clear print areas for clean exports. Ideal for automation and batch processing where consistent, lossless screenshots of spreadsheets are required across environments.", "x-ca-meta-title": "XLS to PNG Conversion API – Excel to PNG images.", "x-ca-meta-description": "Convert XLS to PNG via API. Choose worksheet, set DPI and dimensions, and scale to fit pages for consistent, lossless screenshots.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "png", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xls/to/tiff": { "summary": "XLS to TIFF API", "description": "Render XLS worksheets to TIFF images for archiving and print. Select sheet, set DPI and size, choose scaling, and produce stable raster output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-tiff" }, "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" ] }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "TiffType": { "enum": [ "color24nc", "color32nc", "color24lzw", "color32lzw", "color24zip", "color32zip", "grayscale", "grayscalelzw", "grayscalezip", "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF type.\n * `color24nc` - Color - 24bits RGB output, uncompressed\n * `color32nc` - Color - 32bits CMYK output, uncompressed\n * `color24lzw` - Color - 24bits RGB, LZW-compatible compression\n * `color32lzw` - Color - 32bits CMYK, LZW-compatible compression\n * `color24zip` - Color - 24bits RGB, ZIP (Deflate) compression\n * `color32zip` - Color - 32bits CMYK, ZIP (Deflate) compression\n * `grayscale` - Grayscale - 8bits output, uncompressed\n * `grayscalelzw` - Grayscale - 8bits output, LZW-compatible compression\n * `grayscalezip` - Grayscale - 8bits output, ZIP (Deflate) compression\n * `monochromeg3` - Monochrome - G3 fax encoding with EOLs\n * `monochromeg32d` - Monochrome - 2-D G3 fax encoding\n * `monochromeg4` - Monochrome - G4 fax encoding\n * `monochromelzw` - Monochrome - LZW-compatible compression\n * `monochromepackbits` - Monochrome - PackBits compression", "default": "color24lzw", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color24nc": "Color - 24bits RGB output, uncompressed", "color32nc": "Color - 32bits CMYK output, uncompressed", "color24lzw": "Color - 24bits RGB, LZW-compatible compression", "color32lzw": "Color - 32bits CMYK, LZW-compatible compression", "color24zip": "Color - 24bits RGB, ZIP (Deflate) compression", "color32zip": "Color - 32bits CMYK, ZIP (Deflate) compression", "grayscale": "Grayscale - 8bits output, uncompressed", "grayscalelzw": "Grayscale - 8bits output, LZW-compatible compression", "grayscalezip": "Grayscale - 8bits output, ZIP (Deflate) compression", "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillOrder": { "enum": [ "0", "1" ], "type": "string", "description": "The logical order of bits within a byte.\n * `0` - MSB-to-LSB\n * `1` - LSB-to-MSB", "default": "0", "x-ca-featured": false, "x-ca-label": "Fill order", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "MSB-to-LSB", "1": "LSB-to-MSB" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLS worksheets to TIFF images for review, records management, and print workflows. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match layout or storage constraints. Use auto‑fit and clear print area to ensure clean exports and predictable pagination. Ideal for automation and batch scenarios that require robust, high‑fidelity raster output from spreadsheets across environments.", "x-ca-meta-title": "XLS to TIFF Conversion API – Excel to TIFF images.", "x-ca-meta-description": "Convert XLS to TIFF via API. Select worksheet, set DPI and dimensions, choose scaling, and create predictable, print‑ready raster output.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xls/to/webp": { "summary": "XLS to WebP API", "description": "Render XLS worksheets to WebP for efficient delivery. Select sheet, choose lossless/lossy mode, set quality, DPI, dimensions, and scaling.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-webp" }, "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" ] }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLS worksheets to modern WebP images for compact, high‑quality delivery. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to fit UI or storage constraints. Pick lossless or lossy compression and adjust quality to balance visual fidelity and file size. Ideal for automation pipelines and batch processing where consistent, lightweight spreadsheet screenshots are required across platforms.", "x-ca-meta-title": "XLS to WebP Conversion API – Excel to WebP images.", "x-ca-meta-description": "Convert XLS to WebP via API. Choose sheet, lossless/lossy mode, quality, DPI, dimensions, and scaling for compact, high‑quality output.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "webp", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xls/to/xls": { "summary": "XLS to Excel API", "description": "Convert legacy XLS workbooks to modern Excel formats. Open passwords, normalize layout, preserve metadata, and ensure compatibility across versions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-xls" }, "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" ] }, "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" } } } } } }, "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 or re‑save legacy Excel XLS workbooks to XLS or XLSX to improve interoperability and reduce file issues. Handle password‑protected inputs when necessary and preserve document metadata as part of the conversion pipeline. Use this API to standardize files for analytics, automation, and sharing, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing spreadsheets for downstream systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLS to Excel Conversion API – XLS to XLSX.", "x-ca-meta-description": "Convert XLS to Excel via API. Open password‑protected files, normalize layout, preserve metadata, and ensure cross‑version compatibility.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xls/to/xlsx": { "summary": "XLS to Excel API", "description": "Convert legacy XLS workbooks to modern Excel formats. Open passwords, normalize layout, preserve metadata, and ensure compatibility across versions.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xls-to-xlsx" }, "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" ] }, "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" } } } } } }, "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 or re‑save legacy Excel XLS workbooks to XLS or XLSX to improve interoperability and reduce file issues. Handle password‑protected inputs when necessary and preserve document metadata as part of the conversion pipeline. Use this API to standardize files for analytics, automation, and sharing, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing spreadsheets for downstream systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLS to Excel Conversion API – XLS to XLSX.", "x-ca-meta-description": "Convert XLS to Excel via API. Open password‑protected files, normalize layout, preserve metadata, and ensure cross‑version compatibility.", "x-ca-source-formats": "xls", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xlsb/to/csv": { "summary": "XLSB to CSV API", "description": "Export XLSB worksheets to CSV files. Select sheets by name or index, open password‑protected workbooks, and generate clean, ready‑to‑parse data.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsb-to-csv" }, "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": { "type": "string", "description": "Set one or several worksheet indexes(number) separated by comma 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": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "20000" } }, "WorksheetName": { "type": "string", "description": "Set one or several worksheet names separated by comma 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" } } } } } }, "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 CSV for ingestion by downstream systems and scripts. Choose which worksheets to export using active sheet, index ranges, or name ranges, and process password‑protected files when necessary. Produce clean, line‑delimited output suited for data pipelines, analytics, and archival. Designed for automation, the converter handles single files or batches consistently so results remain predictable across environments and input variations.", "x-ca-meta-title": "XLSB to CSV Conversion API – Export worksheets to CSV.", "x-ca-meta-description": "Export XLSB to CSV via API. Select worksheets by name or index, handle passwords, and produce clean, ready‑to‑parse CSV output.", "x-ca-source-formats": "xlsb", "x-ca-destination-formats": "csv", "x-ca-tags": [ "spreadsheet", "office" ] }, "/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/csv": { "summary": "XLSX to CSV API", "description": "Export XLSX worksheets to CSV files. Select sheets by name or index, open password‑protected workbooks, and generate clean, ready‑to‑parse data.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-csv" }, "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": [ "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": { "type": "string", "description": "Set one or several worksheet indexes(number) separated by comma 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": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "20000" } }, "WorksheetName": { "type": "string", "description": "Set one or several worksheet names separated by comma 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" } } } } } }, "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 XLSX workbooks to CSV for ingestion by downstream systems and scripts. Choose which worksheets to export using active sheet, index ranges, or name ranges, and process password‑protected files when necessary. Produce clean, line‑delimited output suited for data pipelines, analytics, and archival. Designed for automation, the converter handles single files or batches consistently so results remain predictable across environments and input variations.", "x-ca-meta-title": "XLSX to CSV Conversion API – Export worksheets to CSV.", "x-ca-meta-description": "Export XLSX to CSV via API. Select worksheets by name or index, handle passwords, and produce clean, ready‑to‑parse CSV output.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "csv", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xlsx/to/jpg": { "summary": "XLSX to JPG API", "description": "Render XLSX worksheets to JPG images for sharing and review. Select sheet, set DPI and size, tune JPEG quality, and scale to fit pages.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-jpg" }, "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": [ "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "JpgType": { "enum": [ "jpeg", "jpegcmyk", "jpeggray" ], "type": "string", "description": "Set JPG type.\n * `jpeg` - RGB (Full Colors)\n * `jpegcmyk` - CMYK\n * `jpeggray` - Grayscale", "default": "jpeg", "x-ca-featured": false, "x-ca-label": "JPG Type", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "jpeg": "RGB (Full Colors)", "jpegcmyk": "CMYK", "jpeggray": "Grayscale" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLSX worksheets to JPG images for preview, sharing, and archival. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Use JPEG quality options to balance clarity and file size, and auto‑fit columns or pages via model parameters. Ideal for automation and batch processing where consistent visual outputs from spreadsheets are required across environments.", "x-ca-meta-title": "XLSX to JPG Conversion API – Excel to JPG images.", "x-ca-meta-description": "Convert XLSX to JPG via API. Choose worksheet, set DPI and dimensions, scale to fit pages, and tune JPEG quality for efficient delivery.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xlsx/to/pdf": { "summary": "XLSX to PDF API", "description": "Convert 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 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 XLSX to PDF.", "x-ca-meta-description": "Convert 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/xlsx/to/png": { "summary": "XLSX to PNG API", "description": "Render XLSX worksheets to PNG images for sharing and archiving. Select sheet, set DPI and size, and scale to fit pages for consistent output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-png" }, "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": [ "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLSX worksheets to PNG images for preview, sharing, and long‑term archiving. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Auto‑fit columns or pages via model parameters and clear print areas for clean exports. Ideal for automation and batch processing where consistent, lossless screenshots of spreadsheets are required across environments.", "x-ca-meta-title": "XLSX to PNG Conversion API – Excel to PNG images.", "x-ca-meta-description": "Convert XLSX to PNG via API. Choose worksheet, set DPI and dimensions, and scale to fit pages for consistent, lossless screenshots.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "png", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xlsx/to/protect": { "summary": "Protect Excel API", "description": "Encrypt Excel XLSX workbooks with a password using strong AES‑256 protection. Secure files at rest for sharing, archiving, and compliance.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-protect" }, "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "EncryptPassword", "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": [ "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" } }, "EncryptPassword": { "type": "string", "description": "Encrypts the Excel workbook with a password that must be entered to open it.", "x-ca-featured": true, "x-ca-label": "Encrypt password", "x-ca-group": "Security", "x-ca-type": "String", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "Protect Excel XLSX workbooks with robust password‑based encryption to keep sensitive data secure at rest and during transfer. Apply strong AES‑256 encryption with a user‑defined password to prevent unauthorized access while preserving workbook structure and content. Use this API to enforce policy requirements in automated pipelines, prepare documents for external sharing, and meet archival or regulatory obligations. Ideal for organizations standardizing protection of finance, HR, and export files without manual steps in desktop tools.", "x-ca-meta-title": "Protect Excel API – Password encrypt XLSX files.", "x-ca-meta-description": "Encrypt Excel XLSX via API using AES‑256. Set a password to secure workbooks for sharing, archiving, automation, and compliance.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "xlsx", "x-ca-tags": [ "office", "spreadsheet" ] }, "/convert/xlsx/to/tiff": { "summary": "XLSX to TIFF API", "description": "Render XLSX worksheets to TIFF images for archiving and print. Select sheet, set DPI and size, choose scaling, and produce stable raster output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-tiff" }, "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": [ "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "TiffType": { "enum": [ "color24nc", "color32nc", "color24lzw", "color32lzw", "color24zip", "color32zip", "grayscale", "grayscalelzw", "grayscalezip", "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF type.\n * `color24nc` - Color - 24bits RGB output, uncompressed\n * `color32nc` - Color - 32bits CMYK output, uncompressed\n * `color24lzw` - Color - 24bits RGB, LZW-compatible compression\n * `color32lzw` - Color - 32bits CMYK, LZW-compatible compression\n * `color24zip` - Color - 24bits RGB, ZIP (Deflate) compression\n * `color32zip` - Color - 32bits CMYK, ZIP (Deflate) compression\n * `grayscale` - Grayscale - 8bits output, uncompressed\n * `grayscalelzw` - Grayscale - 8bits output, LZW-compatible compression\n * `grayscalezip` - Grayscale - 8bits output, ZIP (Deflate) compression\n * `monochromeg3` - Monochrome - G3 fax encoding with EOLs\n * `monochromeg32d` - Monochrome - 2-D G3 fax encoding\n * `monochromeg4` - Monochrome - G4 fax encoding\n * `monochromelzw` - Monochrome - LZW-compatible compression\n * `monochromepackbits` - Monochrome - PackBits compression", "default": "color24lzw", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color24nc": "Color - 24bits RGB output, uncompressed", "color32nc": "Color - 32bits CMYK output, uncompressed", "color24lzw": "Color - 24bits RGB, LZW-compatible compression", "color32lzw": "Color - 32bits CMYK, LZW-compatible compression", "color24zip": "Color - 24bits RGB, ZIP (Deflate) compression", "color32zip": "Color - 32bits CMYK, ZIP (Deflate) compression", "grayscale": "Grayscale - 8bits output, uncompressed", "grayscalelzw": "Grayscale - 8bits output, LZW-compatible compression", "grayscalezip": "Grayscale - 8bits output, ZIP (Deflate) compression", "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillOrder": { "enum": [ "0", "1" ], "type": "string", "description": "The logical order of bits within a byte.\n * `0` - MSB-to-LSB\n * `1` - LSB-to-MSB", "default": "0", "x-ca-featured": false, "x-ca-label": "Fill order", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "MSB-to-LSB", "1": "LSB-to-MSB" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLSX worksheets to TIFF images for review, records management, and print workflows. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match layout or storage constraints. Use auto‑fit and clear print area to ensure clean exports and predictable pagination. Ideal for automation and batch scenarios that require robust, high‑fidelity raster output from spreadsheets across environments.", "x-ca-meta-title": "XLSX to TIFF Conversion API – Excel to TIFF images.", "x-ca-meta-description": "Convert XLSX to TIFF via API. Select worksheet, set DPI and dimensions, choose scaling, and create predictable, print‑ready raster output.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xlsx/to/webp": { "summary": "XLSX to WebP API", "description": "Render XLSX worksheets to WebP for efficient delivery. Select sheet, choose lossless/lossy mode, set quality, DPI, dimensions, and scaling.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-webp" }, "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": [ "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLSX worksheets to modern WebP images for compact, high‑quality delivery. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to fit UI or storage constraints. Pick lossless or lossy compression and adjust quality to balance visual fidelity and file size. Ideal for automation pipelines and batch processing where consistent, lightweight spreadsheet screenshots are required across platforms.", "x-ca-meta-title": "XLSX to WebP Conversion API – Excel to WebP images.", "x-ca-meta-description": "Convert XLSX to WebP via API. Choose sheet, lossless/lossy mode, quality, DPI, dimensions, and scaling for compact, high‑quality output.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "webp", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xlsx/to/xls": { "summary": "XLSX to Excel API", "description": "Convert XLSX workbooks to XLS or XLSX for compatibility. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-xls" }, "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": [ "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" } } } } } }, "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 or re‑save Excel XLSX workbooks to XLS or XLSX to improve interoperability across tools and versions. Handle password‑protected inputs when required and preserve document metadata through the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing spreadsheets for downstream systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLSX to Excel Conversion API – XLSX to XLS/XLSX.", "x-ca-meta-description": "Convert XLSX to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xlsx/to/xlsx": { "summary": "XLSX to Excel API", "description": "Convert XLSX workbooks to XLS or XLSX for compatibility. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlsx-to-xlsx" }, "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": [ "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" } } } } } }, "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 or re‑save Excel XLSX workbooks to XLS or XLSX to improve interoperability across tools and versions. Handle password‑protected inputs when required and preserve document metadata through the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing spreadsheets for downstream systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLSX to Excel Conversion API – XLSX to XLS/XLSX.", "x-ca-meta-description": "Convert XLSX to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xlsx", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xlt/to/xls": { "summary": "XLT to Excel API", "description": "Convert legacy XLT templates to XLS or XLSX workbooks. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlt-to-xls" }, "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": [ "xlt" ] }, "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" } } } } } }, "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 legacy Excel XLT templates to standard XLS or XLSX workbooks for interoperability and downstream processing. Handle password‑protected inputs when required and preserve document metadata through the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing template‑based spreadsheets for systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLT to Excel Conversion API – Templates to XLS/XLSX.", "x-ca-meta-description": "Convert XLT to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xlt", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xlt/to/xlsx": { "summary": "XLT to Excel API", "description": "Convert legacy XLT templates to XLS or XLSX workbooks. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xlt-to-xlsx" }, "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": [ "xlt" ] }, "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" } } } } } }, "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 legacy Excel XLT templates to standard XLS or XLSX workbooks for interoperability and downstream processing. Handle password‑protected inputs when required and preserve document metadata through the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing template‑based spreadsheets for systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLT to Excel Conversion API – Templates to XLS/XLSX.", "x-ca-meta-description": "Convert XLT to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xlt", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xltx/to/csv": { "summary": "XLTX to CSV API", "description": "Export XLTX templates to CSV files. Select worksheets by name or index, open password‑protected inputs, and produce clean, ready‑to‑parse data.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-csv" }, "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": { "type": "string", "description": "Set one or several worksheet indexes(number) separated by comma 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": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "20000" } }, "WorksheetName": { "type": "string", "description": "Set one or several worksheet names separated by comma 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" } } } } } }, "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 CSV for ingestion by downstream systems and scripts. Choose which worksheets to export using active sheet, index ranges, or name ranges, and process password‑protected files when necessary. Produce clean, line‑delimited output suited for data pipelines, analytics, and archival. Designed for automation, the converter handles single files or batches consistently so results remain predictable across environments and input variations.", "x-ca-meta-title": "XLTX to CSV Conversion API – Export templates to CSV.", "x-ca-meta-description": "Export XLTX to CSV via API. Select worksheets by name or index, handle passwords, and generate clean, ready‑to‑parse CSV output.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "csv", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xltx/to/jpg": { "summary": "XLTX to JPG API", "description": "Render XLTX templates to JPG images for sharing and review. Select sheet, set DPI and size, tune JPEG quality, and scale to fit pages.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-jpg" }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "JpgType": { "enum": [ "jpeg", "jpegcmyk", "jpeggray" ], "type": "string", "description": "Set JPG type.\n * `jpeg` - RGB (Full Colors)\n * `jpegcmyk` - CMYK\n * `jpeggray` - Grayscale", "default": "jpeg", "x-ca-featured": false, "x-ca-label": "JPG Type", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "jpeg": "RGB (Full Colors)", "jpegcmyk": "CMYK", "jpeggray": "Grayscale" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "JPG Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLTX templates to JPG images for preview, sharing, and archival. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Use JPEG quality options to balance clarity and file size, auto‑fit by columns/pages, and clear print areas for clean exports. Ideal for automation and batch processing where consistent visual outputs from spreadsheet templates are required.", "x-ca-meta-title": "XLTX to JPG Conversion API – Templates to JPG images.", "x-ca-meta-description": "Convert XLTX to JPG via API. Choose worksheet, set DPI and dimensions, scale to fit pages, and tune JPEG quality for efficient delivery.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "jpg", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/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" ] }, "/convert/xltx/to/png": { "summary": "XLTX to PNG API", "description": "Render XLTX templates to PNG images for sharing and archiving. Select sheet, set DPI and size, and scale to fit pages for consistent output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-png" }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLTX templates to PNG images for preview, sharing, and long‑term archiving. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match UI or storage constraints. Auto‑fit columns or pages and clear print areas for clean exports. Ideal for automation and batch processing where consistent, lossless screenshots of spreadsheet templates are required across environments.", "x-ca-meta-title": "XLTX to PNG Conversion API – Templates to PNG images.", "x-ca-meta-description": "Convert XLTX to PNG via API. Choose worksheet, set DPI and dimensions, and scale to fit pages for consistent, lossless screenshots.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "png", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xltx/to/tiff": { "summary": "XLTX to TIFF API", "description": "Render XLTX templates to TIFF images for archiving and print. Select sheet, set DPI and size, choose scaling, and produce stable raster output.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-tiff" }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "TiffType": { "enum": [ "color24nc", "color32nc", "color24lzw", "color32lzw", "color24zip", "color32zip", "grayscale", "grayscalelzw", "grayscalezip", "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF type.\n * `color24nc` - Color - 24bits RGB output, uncompressed\n * `color32nc` - Color - 32bits CMYK output, uncompressed\n * `color24lzw` - Color - 24bits RGB, LZW-compatible compression\n * `color32lzw` - Color - 32bits CMYK, LZW-compatible compression\n * `color24zip` - Color - 24bits RGB, ZIP (Deflate) compression\n * `color32zip` - Color - 32bits CMYK, ZIP (Deflate) compression\n * `grayscale` - Grayscale - 8bits output, uncompressed\n * `grayscalelzw` - Grayscale - 8bits output, LZW-compatible compression\n * `grayscalezip` - Grayscale - 8bits output, ZIP (Deflate) compression\n * `monochromeg3` - Monochrome - G3 fax encoding with EOLs\n * `monochromeg32d` - Monochrome - 2-D G3 fax encoding\n * `monochromeg4` - Monochrome - G4 fax encoding\n * `monochromelzw` - Monochrome - LZW-compatible compression\n * `monochromepackbits` - Monochrome - PackBits compression", "default": "color24lzw", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "color24nc": "Color - 24bits RGB output, uncompressed", "color32nc": "Color - 32bits CMYK output, uncompressed", "color24lzw": "Color - 24bits RGB, LZW-compatible compression", "color32lzw": "Color - 32bits CMYK, LZW-compatible compression", "color24zip": "Color - 24bits RGB, ZIP (Deflate) compression", "color32zip": "Color - 32bits CMYK, ZIP (Deflate) compression", "grayscale": "Grayscale - 8bits output, uncompressed", "grayscalelzw": "Grayscale - 8bits output, LZW-compatible compression", "grayscalezip": "Grayscale - 8bits output, ZIP (Deflate) compression", "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillOrder": { "enum": [ "0", "1" ], "type": "string", "description": "The logical order of bits within a byte.\n * `0` - MSB-to-LSB\n * `1` - LSB-to-MSB", "default": "0", "x-ca-featured": false, "x-ca-label": "Fill order", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "MSB-to-LSB", "1": "LSB-to-MSB" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLTX templates to TIFF images for review, records management, and print workflows. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to match layout or storage constraints. Use auto‑fit and clear print area to ensure clean exports and predictable pagination. Ideal for automation and batch scenarios that require robust, high‑fidelity raster output from spreadsheet templates across environments.", "x-ca-meta-title": "XLTX to TIFF Conversion API – Templates to TIFF images.", "x-ca-meta-description": "Convert XLTX to TIFF via API. Select worksheet, set DPI and dimensions, choose scaling, and create predictable, print‑ready raster output.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "tiff", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xltx/to/webp": { "summary": "XLTX to WebP API", "description": "Render XLTX templates to WebP for efficient delivery. Select sheet, choose lossless/lossy mode, set quality, DPI, dimensions, and scaling.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-webp" }, "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" }, "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": "Word", "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", "folio", "quarto", "10x14", "11x17", "note", "envelope9", "envelope10", "envelope11", "envelope12", "envelope14", "csheet", "dsheet", "esheet", "envelopedl", "envelopec3", "envelopec4", "envelopec5", "envelopec6", "envelopec65", "envelopecb4", "envelopeb5", "envelopeb6", "envelopeeurope", "envelopem", "envelopeusa", "fanfoldusa", "fanfoldgerman", "lfanfoldgerman" ], "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\n * `folio` - Folio\n * `quarto` - Quarto\n * `10x14` - 10 x 14 in.\n * `11x17` - 11 x 17 in.\n * `note` - Note\n * `envelope9` - Envelope #9\n * `envelope10` - Envelope #10\n * `envelope11` - Envelope #11\n * `envelope12` - Envelope #12\n * `envelope14` - Envelope #14\n * `csheet` - C size sheet\n * `dsheet` - D size sheet\n * `esheet` - E size sheet\n * `envelopedl` - Envelope DL\n * `envelopec3` - Envelope C3\n * `envelopec4` - Envelope C4\n * `envelopec5` - Envelope C5\n * `envelopec6` - Envelope C6\n * `envelopec65` - Envelope C65\n * `envelopecb4` - Envelope B4\n * `envelopeb5` - Envelope B5\n * `envelopeb6` - Envelope B6\n * `envelopeeurope` - Envelope Europe\n * `envelopem` - Envelope Monarch\n * `envelopeusa` - Envelope USA\n * `fanfoldusa` - U.S. Standard Fanfold\n * `fanfoldgerman` - German Standard Fanfold\n * `lfanfoldgerman` - German Legal Fanfold", "default": "default", "x-ca-featured": false, "x-ca-label": "Page size", "x-ca-group": "Word", "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", "folio": "Folio", "quarto": "Quarto", "10x14": "10 x 14 in.", "11x17": "11 x 17 in.", "note": "Note", "envelope9": "Envelope #9", "envelope10": "Envelope #10", "envelope11": "Envelope #11", "envelope12": "Envelope #12", "envelope14": "Envelope #14", "csheet": "C size sheet", "dsheet": "D size sheet", "esheet": "E size sheet", "envelopedl": "Envelope DL", "envelopec3": "Envelope C3", "envelopec4": "Envelope C4", "envelopec5": "Envelope C5", "envelopec6": "Envelope C6", "envelopec65": "Envelope C65", "envelopecb4": "Envelope B4", "envelopeb5": "Envelope B5", "envelopeb6": "Envelope B6", "envelopeeurope": "Envelope Europe", "envelopem": "Envelope Monarch", "envelopeusa": "Envelope USA", "fanfoldusa": "U.S. Standard Fanfold", "fanfoldgerman": "German Standard Fanfold", "lfanfoldgerman": "German Legal Fanfold" } }, "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.", "default": 100, "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" } }, "ImageQuality": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set output image quality.", "default": 75, "x-ca-featured": false, "x-ca-label": "Output image quality", "x-ca-group": "WebP Output", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "ImageResolutionH": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image horizontal resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Horizontal image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ImageResolutionV": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Set output image vertical resolution in dpi.", "default": 200, "x-ca-featured": false, "x-ca-label": "Vertical image resolution", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "ScaleImage": { "type": "boolean", "description": "Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale image", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleProportions": { "type": "boolean", "description": "Constrain proportions when scaling the output image.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ScaleIfLarger": { "type": "boolean", "description": "Scaling only if the input image is larger than the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Scale if larger", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageHeight": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image height in pixels.", "x-ca-featured": false, "x-ca-label": "Image height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "ImageWidth": { "maximum": 20000, "minimum": 10, "type": "integer", "description": "Image width in pixels.", "x-ca-featured": false, "x-ca-label": "Image width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "20000" } }, "TextAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Text antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "GraphicsAntialiasing": { "enum": [ "0", "1", "2", "4" ], "type": "string", "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits", "default": "1", "x-ca-featured": false, "x-ca-label": "Graphics antialiasing", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "None", "1": "1 bit", "2": "2 bits", "4": "4 bits" } }, "ImageInterpolation": { "type": "boolean", "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.", "default": false, "x-ca-featured": false, "x-ca-label": "Image interpolation", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UseCIEColor": { "type": "boolean", "description": "Specifies whether the image parser should remap the device-dependent.", "default": false, "x-ca-featured": false, "x-ca-label": "Use CIE Color", "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": "Convert Excel XLTX templates to modern WebP images for compact, high‑quality delivery. Select the sheet by name, index, or the active sheet. Control image resolution (DPI), choose scaling behavior, and set explicit width/height to fit UI or storage constraints. Pick lossless or lossy compression and adjust quality to balance visual fidelity and file size. Ideal for automation pipelines and batch processing where consistent, lightweight spreadsheet screenshots are required across platforms.", "x-ca-meta-title": "XLTX to WebP Conversion API – Templates to WebP images.", "x-ca-meta-description": "Convert XLTX to WebP via API. Choose sheet, lossless/lossy mode, quality, DPI, dimensions, and scaling for compact, high‑quality output.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "webp", "x-ca-tags": [ "spreadsheet", "office", "image" ] }, "/convert/xltx/to/xls": { "summary": "XLTX to Excel API", "description": "Convert Excel XLTX templates to XLS or XLSX workbooks. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-xls" }, "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" } } } } } }, "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 standard XLS or XLSX workbooks for interoperability and downstream processing. Handle password‑protected inputs when required and preserve document metadata throughout the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing template‑based spreadsheets for systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLTX to Excel Conversion API – Templates to XLS/XLSX.", "x-ca-meta-description": "Convert XLTX to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xltx/to/xlsx": { "summary": "XLTX to Excel API", "description": "Convert Excel XLTX templates to XLS or XLSX workbooks. Open passwords, preserve metadata, and normalize layout for reliable automation.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xltx-to-xlsx" }, "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" } } } } } }, "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 standard XLS or XLSX workbooks for interoperability and downstream processing. Handle password‑protected inputs when required and preserve document metadata throughout the conversion pipeline. Use this API to standardize files for analytics, automation, and collaboration, ensuring consistent structure and rendering across Office versions and platforms. Ideal for bulk migrations, workflow normalization, and preparing template‑based spreadsheets for systems that expect clean, modern Excel files.", "x-ca-meta-title": "XLTX to Excel Conversion API – Templates to XLS/XLSX.", "x-ca-meta-description": "Convert XLTX to Excel via API. Open passwords, preserve metadata, and normalize layout for reliable, cross‑version compatibility.", "x-ca-source-formats": "xltx", "x-ca-destination-formats": "xls,xlsx", "x-ca-tags": [ "spreadsheet", "office" ] }, "/convert/xml/to/docx": { "summary": "XML to DOCX", "description": "The API for converting one Word document to another word document format.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xml-to-docx" }, "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": [ "docx", "doc", "odt", "dotx", "xml" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "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" }, "UpdateReferences": { "type": "boolean", "description": "Update all reference fields in the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Update reference fields", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The API for converting Word {0} to {1} document.", "x-ca-meta-title": null, "x-ca-meta-description": null, "x-ca-source-formats": "docx,doc,odt,dotx,xml", "x-ca-destination-formats": "docx,odt,rtf", "x-ca-tags": [ "document", "office" ] }, "/convert/xml/to/odt": { "summary": "XML to ODT", "description": "The API for converting one Word document to another word document format.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xml-to-odt" }, "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": [ "docx", "doc", "odt", "dotx", "xml" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "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" }, "UpdateReferences": { "type": "boolean", "description": "Update all reference fields in the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Update reference fields", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The API for converting Word {0} to {1} document.", "x-ca-meta-title": null, "x-ca-meta-description": null, "x-ca-source-formats": "docx,doc,odt,dotx,xml", "x-ca-destination-formats": "docx,odt,rtf", "x-ca-tags": [ "document", "office" ] }, "/convert/xml/to/rtf": { "summary": "XML to RTF", "description": "The API for converting one Word document to another word document format.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/xml-to-rtf" }, "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": [ "docx", "doc", "odt", "dotx", "xml" ] }, "FileName": { "type": "string", "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.", "x-ca-featured": false, "x-ca-label": "Output file name", "x-ca-group": "Output", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "Password": { "type": "string", "description": "Sets the password to open protected documents.", "x-ca-featured": false, "x-ca-label": "Open Password", "x-ca-group": "Document", "x-ca-type": "String", "x-ca-representation": "Default" }, "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" }, "UpdateReferences": { "type": "boolean", "description": "Update all reference fields in the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Update reference fields", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ConversionCost": { "type": "integer", "description": "This amount will be deducted from your balance after the conversion.", "format": "int32", "example": 1 }, "Files": { "type": "array", "items": { "type": "object", "properties": { "FileName": { "type": "string", "description": "Name of the converted file.", "example": "myfile.pdf" }, "FileExt": { "type": "string", "description": "File type (file name extension)", "example": "pdf" }, "FileSize": { "type": "integer", "description": "File size", "format": "int32", "example": 111955 }, "FileId": { "type": "string", "description": "File ID", "example": "25811safe8e61dd3f51ef00ee5f58b92" }, "Url": { "type": "string", "description": "File URL", "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf" }, "FileData": { "type": "string", "description": "Base64 encoded file data", "format": "base64", "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..." } } } } }, "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationjson-1" } } }, "multipart/mixed": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#multipartmixed" } }, "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n" }, "application/octet-stream": { "schema": { "type": "string", "format": "binary", "externalDocs": { "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1" } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" }, "503": { "$ref": "#/components/responses/503" } }, "security": [ { "secret": [ ] }, { "token": [ ] }, { "jwt": [ ] } ] }, "x-ca-overview": "The API for converting Word {0} to {1} document.", "x-ca-meta-title": null, "x-ca-meta-description": null, "x-ca-source-formats": "docx,doc,odt,dotx,xml", "x-ca-destination-formats": "docx,odt,rtf", "x-ca-tags": [ "document", "office" ] }, "/convert/zip/to/extract": { "summary": "Unzip API", "description": "Extract files and folders from ZIP archives with password support, selective extraction, and output naming for safe unpacking.", "post": { "tags": [ "Conversion" ], "externalDocs": { "description": "Read more about the converter", "url": "https://www.convertapi.com/zip-to-extract" }, "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": [ "zip" ] }, "Password": { "type": "string", "description": "Sets the password to open protected archive.", "x-ca-featured": false, "x-ca-label": "Archive Open Password", "x-ca-group": "Archive", "x-ca-type": "String", "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": "Extract the contents of ZIP archives programmatically with simple API calls. Provide an input archive, optional password, and control how files are written to the output, including naming and structure. Ideal for automated pipelines that receive packaged data and need safe, reliable unpacking without desktop software.", "x-ca-meta-title": "Unzip API – Extract ZIP Archives with Password Support.", "x-ca-meta-description": "Extract ZIP archives via API with password support and selective extraction. Control output naming for safe, automated unpacking and workflows.", "x-ca-source-formats": "zip", "x-ca-destination-formats": "any", "x-ca-tags": [ "archive" ] } }, "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" } }