{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "ConversionRequest", "description": "Common properties for ConvertAPI conversion request bodies", "type": "object", "properties": { "file": { "type": "string", "description": "The file to upload", "format": "binary" }, "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\u2019s 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": [ "ai" ] }, "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": "If set to true, the barcode will be generated using recommended proportions based on the larger dimension.", "default": true, "x-ca-featured": false, "x-ca-label": "Scale Proportions", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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.", "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" } }, "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": "Color", "x-ca-representation": "Default" }, "MultiPage": { "type": "boolean", "description": "Create multi-page TIFF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Multi-page", "x-ca-group": "TIFF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Password": { "type": "string", "description": "Sets the password to open protected PDF.", "x-ca-featured": false, "x-ca-label": "Open password", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRange": { "type": "string", "description": "Set PDF page range to convert. Example 1-10 or 1,2,5.", "default": "1-2000", "x-ca-featured": false, "x-ca-label": "Page Range", "x-ca-group": "PDF", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "BarcodeFormat": { "enum": [ "auto", "code128", "code39", "qrcode", "datamatrix", "ean13", "ean8", "pdf417", "aztec", "upca", "upce", "itf14" ], "type": "string", "description": "The format of the barcode to detect. Select 'Auto' to detect all supported formats.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Barcode Format", "x-ca-group": "Barcode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "code128": "Code 128", "code39": "Code 39", "qrcode": "QR Code", "datamatrix": "Data Matrix", "ean13": "EAN-13", "ean8": "EAN-8", "pdf417": "PDF 417", "aztec": "Aztec", "upca": "UPC-A", "upce": "UPC-E", "itf14": "ITF-14" } }, "DetectMultiple": { "type": "boolean", "description": "If set to true, the converter will attempt to detect multiple barcodes.", "default": false, "x-ca-featured": false, "x-ca-label": "Detect Multiple", "x-ca-group": "Barcode", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "EnhancedDetection": { "type": "boolean", "description": "If set to true, the converter will use more intensive algorithms to detect barcodes.", "default": false, "x-ca-featured": false, "x-ca-label": "Enhanced Detection", "x-ca-group": "Barcode", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "IncludeInverted": { "type": "boolean", "description": "If set to true, the converter will also try to detect barcodes with inverted colors.", "default": false, "x-ca-featured": false, "x-ca-label": "Include Inverted", "x-ca-group": "Barcode", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AutoRotate": { "type": "boolean", "description": "If set to true, the converter will automatically rotate the view to detect barcodes.", "default": false, "x-ca-featured": false, "x-ca-label": "Auto Rotate", "x-ca-group": "Barcode", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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" } }, "ColorProfile": { "enum": [ "default", "isocoatedv2" ], "type": "string", "description": "Set image color profile. Some profiles will override the ColorSpace property.", "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.", "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.", "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" }, "Preset": { "enum": [ "none", "detailed", "crisp", "graphic", "illustration", "noisyScan" ], "type": "string", "description": "Choose a vectorization preset with general tracing settings suited for different image types. When a preset is selected, all converter options except `ColorMode` are ignored. Presets provide ready-made configurations for producing consistent and balanced SVG results.", "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.", "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.", "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": "Defines how shapes are approximated during tracing. The `Pixel` mode follows exact pixel boundaries with minimal smoothing, `Polygon` forms straight-edged paths with sharp corners, and `Spline` generates smooth, continuous curves for more natural shapes.", "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" } }, "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" }, "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.", "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)" } }, "Delimiter": { "type": "string", "description": "Set fields separator.", "default": ",", "x-ca-featured": true, "x-ca-label": "Fields separator", "x-ca-group": "CSV", "x-ca-type": "String", "x-ca-representation": "Default" }, "CellType": { "enum": [ "general", "text" ], "type": "string", "description": "Set Excel cell type, if set as text the date and number format will be the same as in CSV file.", "default": "text", "x-ca-featured": false, "x-ca-label": "Cell Type", "x-ca-group": "Excel", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "general": "General", "text": "Text" } }, "Data": { "type": "string", "description": "The value to encode in the barcode. Can contain plain text or structured content. Common use cases include URLs, email links, SMS messages, and contact details (vCard). Advanced formats such as payment instructions (e.g., SEPA) or cryptocurrency URIs allow encoding of actionable, machine-readable data.", "x-ca-featured": true, "x-ca-label": "Data", "x-ca-group": "Input", "x-ca-type": "String", "x-ca-representation": "Default" }, "OutputFormat": { "enum": [ "svg", "png", "jpg", "tiff" ], "type": "string", "description": "The format of the output image.", "default": "svg", "x-ca-featured": false, "x-ca-label": "Output Format", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "svg": "SVG", "png": "PNG", "jpg": "JPG", "tiff": "TIFF" } }, "Margin": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "The margin of the barcode image in pixels.", "default": 0, "x-ca-featured": false, "x-ca-label": "Margin", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } }, "Gs1Format": { "type": "boolean", "description": "If set to true, the barcode will be generated in GS1 format.", "default": false, "x-ca-featured": false, "x-ca-label": "GS1 Format", "x-ca-group": "Barcode", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BaseFontSize": { "maximum": 50, "minimum": 1, "type": "number", "description": "Base font size in points (pt). All text is scaled relative to this value.", "default": 12, "x-ca-featured": false, "x-ca-label": "Base font size", "x-ca-group": "Options", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "50" } }, "MarginLeft": { "maximum": 200, "minimum": 0, "type": "number", "description": "Sets the left margin in points (pt) for text on the PDF page.", "default": 40, "x-ca-featured": false, "x-ca-label": "Margin Left", "x-ca-group": "PDF", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "MarginRight": { "maximum": 200, "minimum": 0, "type": "number", "description": "Sets the right margin in points (pt) for text on the PDF page.", "default": 40, "x-ca-featured": false, "x-ca-label": "Margin Right", "x-ca-group": "PDF", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "MarginTop": { "maximum": 200, "minimum": 0, "type": "number", "description": "Sets the top margin in points (pt) for text on the PDF page.", "default": 40, "x-ca-featured": false, "x-ca-label": "Margin Top", "x-ca-group": "PDF", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "MarginBottom": { "maximum": 200, "minimum": 0, "type": "number", "description": "Sets the bottom margin in points (pt) for text on the PDF page.", "default": 40, "x-ca-featured": false, "x-ca-label": "Margin Bottom", "x-ca-group": "PDF", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "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" }, "Sexual": { "type": "boolean", "description": "Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services excluding sex education and wellness.", "default": true, "x-ca-featured": false, "x-ca-label": "Sexual", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Harassment": { "type": "boolean", "description": "Content that expresses, incites, or promotes harassing language towards any target. Includes harassment/threatening sub-category.", "default": true, "x-ca-featured": false, "x-ca-label": "Harassment", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Hate": { "type": "boolean", "description": "Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Includes hate/threatening sub-category.", "default": true, "x-ca-featured": false, "x-ca-label": "Hate", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Illicit": { "type": "boolean", "description": "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. Includes illicit/violent sub-category.", "default": true, "x-ca-featured": false, "x-ca-label": "Illicit", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SelfHarm": { "type": "boolean", "description": "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders. Includes self-harm/intent and self-harm/instructions sub-categories.", "default": true, "x-ca-featured": false, "x-ca-label": "Self Harm", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Violence": { "type": "boolean", "description": "Content that depicts death, violence, or physical injury. Includes violence/graphic sub-category.", "default": true, "x-ca-featured": false, "x-ca-label": "Violence", "x-ca-group": "Moderation", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareFile": { "type": "string", "description": "Specifies the Word document with which the specified document is compared.", "format": "binary", "x-ca-featured": true, "x-ca-label": "Compare file", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "docx" ] }, "CompareLevel": { "enum": [ "Word", "Character" ], "type": "string", "description": "The property defines the granularity of comparisons between documents or text segments. It determines the precision of the comparison process, allowing users to specify whether differences are identified based on larger text blocks, such as words or sentences, or at a more detailed level, such as characters or formatting.", "default": "Word", "x-ca-featured": false, "x-ca-label": "CompareLevel", "x-ca-group": "Compare", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Word": "Word", "Character": "Character" } }, "CompareFormatting": { "type": "boolean", "description": "Determines whether to indicate variations in formatting between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare formatting", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareCaseChanges": { "type": "boolean", "description": "Determines whether to highlight discrepancies in capitalization between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare case changes", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareWhitespace": { "type": "boolean", "description": "Determines whether to identify dissimilarities in whitespace, such as gaps or paragraphs, between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare whitespace", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareTables": { "type": "boolean", "description": "Determines whether to evaluate variations in the information presented within tables between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare tables", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareHeaders": { "type": "boolean", "description": "Determines whether to contrast divergences in headers and footers between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare headers", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareFootnotes": { "type": "boolean", "description": "Determines whether to compare differences in footnotes and endnotes between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare footnotes", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareTextboxes": { "type": "boolean", "description": "Determines whether to assess differences in the information presented within text boxes between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare textboxes", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareFields": { "type": "boolean", "description": "Determines whether to detect disparities in fields between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare fields", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareComments": { "type": "boolean", "description": "Determines whether to evaluate distinctions in comments between the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare comments", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CompareMoves": { "type": "boolean", "description": "Indicates the name of the individual to credit for modifications when comparing the two documents.", "default": true, "x-ca-featured": false, "x-ca-label": "Compare moves", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AcceptRevisions": { "type": "boolean", "description": "Specifies whether to accept revisions before document comparison.", "default": false, "x-ca-featured": false, "x-ca-label": "Accept revisions", "x-ca-group": "Compare", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RevisionAuthor": { "type": "string", "description": "Author name who made revision.", "default": "Compared using ConvertAPI", "x-ca-featured": false, "x-ca-label": "Revision author", "x-ca-group": "Compare", "x-ca-type": "String", "x-ca-representation": "Default" }, "InlineImages": { "type": "boolean", "description": "Inline images to html.", "default": true, "x-ca-featured": false, "x-ca-label": "Inline images", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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" }, "BookmarkMode": { "enum": [ "none", "headings", "bookmarks" ], "type": "string", "description": "Specifies how bookmarks are created in the generated PDF: `None` disables bookmark creation, `Headings` generates bookmarks based on document headings, and `Bookmarks` uses existing bookmarks defined in the original file.", "default": "headings", "x-ca-featured": false, "x-ca-label": "Bookmark Mode", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "headings": "Headings", "bookmarks": "Bookmarks" } }, "EncryptPassword": { "type": "string", "description": "Sets a password to encrypt the Word document. This password is required to open and view the content.", "x-ca-featured": true, "x-ca-label": "Encrypt password", "x-ca-group": "Security", "x-ca-type": "String", "x-ca-representation": "Default" }, "Substitutions": { "type": "boolean", "description": "Replace similar symbols with their counterparts in a text file, such as a copyright symbol with (c).", "default": false, "x-ca-featured": false, "x-ca-label": "Enable Substitutions", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "LineBreaks": { "type": "boolean", "description": "Inserts line breaks at the end of each line of text.", "default": true, "x-ca-featured": false, "x-ca-label": "Insert Line Breaks", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "EndLineChar": { "enum": [ "crlf", "cr", "lfcr", "lf" ], "type": "string", "description": "Set end of line character. The character which will be used to break lines.", "default": "crlf", "x-ca-featured": false, "x-ca-label": "End Line Character", "x-ca-group": "Text", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "crlf": "CR+LF (Windows)", "cr": "CR (Windows)", "lfcr": "LFCR (Mac OS)", "lf": "LF (Mac OS)" } }, "SaveFormat": { "enum": [ "wintext", "wintextlb", "dostext", "dostextlb", "unicodetext" ], "type": "string", "description": "Specifies the format to use when saving a document.", "default": "unicodetext", "x-ca-featured": false, "x-ca-label": "Save Format", "x-ca-group": "Text", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "wintext": "Windows Text", "wintextlb": "Windows Text with line breaks preserved", "dostext": "DOS text", "dostextlb": "DOS text with line breaks preserved", "unicodetext": "Unicode text format" } }, "XmlType": { "enum": [ "word2003", "flatWordXml", "strictOpenXml" ], "type": "string", "description": "Specifies the type of XML to use when saving a Word document.", "default": "word2003", "x-ca-featured": false, "x-ca-label": "Xml Type", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "word2003": "Word 2003 (legacy)", "flatWordXml": "Word Flat OPC XML", "strictOpenXml": "Strict Open XML Document" } }, "SpaceToConvert": { "enum": [ "default", "all", "model" ], "type": "string", "description": "Set space type to convert.", "default": "default", "x-ca-featured": false, "x-ca-label": "Space to convert", "x-ca-group": "AutoCAD", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "all": "All layouts", "model": "Model space" } }, "CustomSpaceToConvert": { "type": "string", "description": "Set custom layout name to convert by setting it name or index. This property overrides the SpaceToConvert property.", "x-ca-featured": false, "x-ca-label": "Custom space to convert", "x-ca-group": "AutoCAD", "x-ca-type": "String", "x-ca-representation": "Default" }, "ExportLayers": { "type": "boolean", "description": "Export AutoCAD layers.", "default": true, "x-ca-featured": false, "x-ca-label": "Export Layers", "x-ca-group": "AutoCAD", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AutoFit": { "type": "boolean", "description": "The converted drawing is detected and adjusted to fit the current page size, with the possibility of changing the page orientation to accommodate the drawing.", "default": true, "x-ca-featured": false, "x-ca-label": "Auto Fit", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "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" } }, "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" } }, "BackgroundColor": { "type": "string", "description": "Applies a color to the transparent PDF background, thereby setting the background color of the generated images. You can specify a color name (e.g. `white` or `black`), or use color codes such as RGB (e.g. `255,0,0`) or HEX (e.g. `#FF0000`). To preserve transparency, set the property value to `transparent`.", "x-ca-featured": false, "x-ca-label": "Background Color", "x-ca-group": "Image", "x-ca-type": "Color", "x-ca-representation": "Default" }, "ImageAntialiasing": { "maximum": 8, "minimum": 0, "type": "integer", "description": "Control the use of text and graphics subsample antialiasing. The subsampling box size should be 8 bits for optimum text antialiasing, but smaller values can be used for faster rendering.", "default": 8, "x-ca-featured": false, "x-ca-label": "Image antialiasing", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "8" } }, "UseCIDAsFileName": { "type": "boolean", "description": "Use the CID as the filename instead of the original when extracting email attachments.", "default": false, "x-ca-featured": false, "x-ca-label": "CID file name", "x-ca-group": "Email", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "IgnoreInlineAttachments": { "type": "boolean", "description": "When enabled, inline attachments such as embedded images, logos, and similar content are skipped during processing. Only non-inline attachments are included in the output.", "default": false, "x-ca-featured": false, "x-ca-label": "Ignore inline attachments", "x-ca-group": "Email", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertHeader": { "type": "boolean", "description": "This property controls the inclusion of email header in the PDF conversion process. \r\nWhen set to `true`, the converter will incorporate the email's header information, such as **From**, **To**, **Subject**, **Date**, etc., into the generated PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Convert Header", "x-ca-group": "Email", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertAttachments": { "type": "boolean", "description": "Convert email attachments.", "default": false, "x-ca-featured": false, "x-ca-label": "Convert attachments", "x-ca-group": "Email", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "IgnoreAttachmentErrors": { "type": "boolean", "description": "When enabled, attachment conversion errors are ignored and the email is still converted. This parameter is only used when `ConvertAttachments` is enabled.", "default": false, "x-ca-featured": false, "x-ca-label": "Ignore attachment errors", "x-ca-group": "Email", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Merge": { "type": "boolean", "description": "Merge email body with attachments during the conversion process. Only works when `ConvertAttachments` property enabled. ", "default": true, "x-ca-featured": false, "x-ca-label": "Merge body and attachments", "x-ca-group": "Email", "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" } }, "PdfVersion": { "enum": [ "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "2.0" ], "type": "string", "description": "Set PDF version.", "default": "1.5", "x-ca-featured": false, "x-ca-label": "PDF version", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "1.2": "Acrobat 3 (PDF 1.2)", "1.3": "Acrobat 4 (PDF 1.3)", "1.4": "Acrobat 5 (PDF 1.4)", "1.5": "Acrobat 6 (PDF 1.5)", "1.6": "Acrobat 7 (PDF 1.6)", "1.7": "Acrobat 8 (PDF 1.7)", "1.8": "Acrobat 9 (PDF 1.7, e-level 3)", "2.0": "Acrobat DC (PDF 2.0)" } }, "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" } }, "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" } }, "OpenZoom": { "enum": [ "Default", "ActualSize", "FitPage", "FitWidth", "FitHeight", "FitVisible", "25", "50", "75", "100", "125", "150", "200", "400", "800", "1600", "2400", "3200", "6400" ], "type": "string", "description": "Set the default zoom percentage for when you open PDF files .", "default": "Default", "x-ca-featured": false, "x-ca-label": "PDF default zoom", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Default": "Default", "ActualSize": "Actual Size", "FitPage": "Fit Page", "FitWidth": "Fit Width", "FitHeight": "Fit Height", "FitVisible": "Fit Visible", "25": "25%", "50": "50%", "75": "75%", "100": "100%", "125": "125%", "150": "150%", "200": "200%", "400": "400%", "800": "800%", "1600": "1600%", "2400": "2400%", "3200": "3200%", "6400": "6400%" } }, "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": [ "docx", "doc", "dot", "dotx", "wpd", "rtf", "log", "csv", "xls", "xlsb", "xlsx", "xlt", "xltx", "xml", "json", "potx", "pps", "ppsx", "ppt", "pptx", "vsd", "vst", "vsdx", "vstx", "vdx", "pub", "dwf", "dwfx", "dwg", "dwgx", "dxf", "odc", "odf", "odg", "odm", "odp", "ods", "odt", "otg", "ots", "sxw", "jpg", "jpeg", "tif", "tiff", "png", "bmp", "gif", "fax", "ico", "heic", "heif", "webp", "svg", "psd", "ai", "eml", "mbx", "msg", "oft", "htm", "html", "zip", "azv", "azv1", "azv3", "azv4", "epub", "mobi", "prc", "tpz", "lit", "cbz", "cbr", "cbc", "djvu", "lrf", "pml", "snb", "tcr", "eps", "ps", "pr", "pdf", "txt", "md", "pages", "numbers", "key", "jxl", "fdf", "mhtml", "po", "jfif", "pcl" ] }, "CompressionLevel": { "enum": [ "Optimal", "Medium", "Fastest", "NoCompression" ], "type": "string", "description": "Set compression level.", "default": "NoCompression", "x-ca-featured": false, "x-ca-label": "Compression Level", "x-ca-group": "Archive", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Optimal": "Optimal", "Medium": "Medium", "Fastest": "Fastest", "NoCompression": "No Compression" } }, "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" } }, "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" }, "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", "146", "147", "148" ], "type": "string", "description": "Specify a particular version of the Chromium engine to render the web page.", "default": "148", "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 (148)", "146": "146", "147": "147", "148": "148" } }, "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" }, "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" } }, "GithubFlavored": { "type": "boolean", "description": "Create GitHub-flavored markdown GFM.", "default": false, "x-ca-featured": false, "x-ca-label": "Github flavored markdown", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveComments": { "type": "boolean", "description": "Remove comment tags.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove comments", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UnsupportedTags": { "enum": [ "PassThrough", "Drop", "Bypass", "Fail" ], "type": "string", "description": "Sets the rules on how to handle unsupported HTML tags.", "default": "PassThrough", "x-ca-featured": false, "x-ca-label": "Process unsupported tags", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "PassThrough": "PassThrough unsupported tags", "Drop": "Drop unsupported tags and content", "Bypass": "Bypass unsupported tags but convert content", "Fail": "Fail and throw exception" } }, "PassThroughTags": { "type": "string", "description": "Enter pass-through tags, separating them with commas. The tags will be copied to the MD document without processing. The UnsupportedTags property should be set to PassThrough.", "x-ca-featured": false, "x-ca-label": "Pass through tags", "x-ca-group": "Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "ListBulletChar": { "type": "string", "description": "Set bullet list character.", "default": "-", "x-ca-featured": false, "x-ca-label": "List bullet char", "x-ca-group": "Options", "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" }, "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.", "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" }, "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" }, "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" }, "JoinDirection": { "enum": [ "vertical", "horizontal" ], "type": "string", "description": "The property determines the direction in which individual images are combined into a single image. This property specifies whether the images will be joined in a vertical or horizontal sequence, allowing for flexible layout configurations.", "default": "vertical", "x-ca-featured": false, "x-ca-label": "Join direction", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "vertical": "Vertical", "horizontal": "Horizontal" } }, "ImageSpacing": { "maximum": 200, "minimum": 0, "type": "integer", "description": "The property defines the amount of space, in pixels, between individual images when they are combined into a single image.", "default": 0, "x-ca-featured": false, "x-ca-label": "Spacing between images", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "SpacingColor": { "type": "string", "description": "The property defines the color of the space between individual images when they are combined into a single image. \r\nThis property works in conjunction with `ImageSpacing` to enhance the visual appearance of the composite image by allowing customization of the spacing area's color.", "x-ca-featured": false, "x-ca-label": "Space color", "x-ca-group": "Image", "x-ca-type": "Color", "x-ca-representation": "Default" }, "ImageOutputFormat": { "enum": [ "auto", "jpg", "png", "tiff" ], "type": "string", "description": "The property specifies the format of the final image after the individual images have been joined. This property allows you to choose the desired file format for the output image, ensuring compatibility with different use cases and requirements. Additionally, it provides an option to automatically detect the output format based on the format of the joining images.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Image format", "x-ca-group": "Image", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "jpg": "JPG", "png": "PNG", "tiff": "TIFF" } }, "CompressionPercentage": { "maximum": 100, "minimum": 10, "type": "integer", "description": "Set compression level in percentage. Overrides `CompressionLevel` property unless it is set to `losseless`.", "x-ca-featured": false, "x-ca-label": "Compression percentage", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "100" } }, "CompressionFileSize": { "maximum": 30000, "minimum": 10, "type": "integer", "description": "Compress a file to the file size set in kilobytes. Overrides `CompressionLevel` property unless it is set to `losseless`.", "x-ca-featured": false, "x-ca-label": "Compression file size", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "30000" } }, "EnableOcr": { "type": "boolean", "description": "Enable optical character recognition(OCR).", "default": false, "x-ca-featured": false, "x-ca-label": "Enable OCR", "x-ca-group": "OCR", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OcrLanguage": { "enum": [ "auto", "ar", "ca", "zh", "da", "nl", "en", "fi", "fr", "de", "el", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "ua", "th" ], "type": "string", "description": "Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Language", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "ar": "Arabic", "ca": "Catalan", "zh": "Chinese", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "ua": "Ukrainian", "th": "Thai" } }, "Preprocessing": { "type": "boolean", "description": "Enables advanced image preprocessing (e.g., deskew, thresholding, resizing, sharpening) to enhance text clarity and improve OCR accuracy at the cost of increased processing time.", "default": true, "x-ca-featured": false, "x-ca-label": "Image Preprocessing", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PdfaVersion": { "enum": [ "none", "pdfA1b", "pdfA2b", "pdfA3b" ], "type": "string", "description": "Set PDF/A version.", "default": "none", "x-ca-featured": false, "x-ca-label": "PDF/A version", "x-ca-group": "PDF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "pdfA1b": "PDF/A-1b", "pdfA2b": "PDF/A-2b", "pdfA3b": "PDF/A-3b" } }, "UnembedBaseFonts": { "type": "boolean", "description": "Specifies whether to remove the base fonts from the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Unembed base fonts", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SubsetEmbeddedFonts": { "type": "boolean", "description": "Output PDF should only contain font characters utilized in the original document, and any unused glyphs from all fonts in the document should be removed.", "default": false, "x-ca-featured": false, "x-ca-label": "Subset embedded fonts", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveForms": { "type": "boolean", "description": "Remove PDF forms from the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove forms", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveDuplicates": { "type": "boolean", "description": "Remove duplicate fonts and color profiles from the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove duplicates", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Optimize": { "type": "boolean", "description": "Optimize page content streams in the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Optimize content", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemovePieceInformation": { "type": "boolean", "description": "Remove piece information dictionaries like Adobe Illustrator or Photoshop private data.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove piece information", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveEmbeddedFiles": { "type": "boolean", "description": "Remove embedded/attachments files from the PDF file.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove embedded files", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveStructureInformation": { "type": "boolean", "description": "Remove all structure information from the PDF document.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove structure information", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveMetadata": { "type": "boolean", "description": "Detach the XMP metadata embedded in the document from its catalog, clear all properties in all schemas, and remove metadata from marked content.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove metadata", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveUnusedResources": { "type": "boolean", "description": "Remove references to resources such as fonts, images, patterns.", "default": true, "x-ca-featured": false, "x-ca-label": "Remove unused resources", "x-ca-group": "Remove Objects", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Linearize": { "type": "boolean", "description": "Linearize PDF file and optimize for fast Web View.", "default": false, "x-ca-featured": false, "x-ca-label": "Linearize", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PreservePdfa": { "type": "boolean", "description": "Preserve the PDF/A standard in the PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Preserve PDF/A", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CropMode": { "enum": [ "auto", "size", "margins" ], "type": "string", "description": "Defines how pages are cropped: automatic content detection, cropping by margins, or cropping to an exact size using width/height or paper size.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Crop mode", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto (detect content)", "size": "Size (width/height)", "margins": "Margins" } }, "MeasurementUnit": { "enum": [ "pt", "in", "mm", "cm" ], "type": "string", "description": "Specifies measurement unit to use for the page height and page width properties.", "default": "in", "x-ca-featured": false, "x-ca-label": "Measurement unit", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pt": "Points", "in": "Inches", "mm": "Millimeters", "cm": "Centimeters" } }, "AutoStrategy": { "enum": [ "perPage", "uniform" ], "type": "string", "description": "Defines whether automatic cropping is applied per page or uniformly across all pages. Takes effect when `CropMode` is set to `Auto`.", "default": "uniform", "x-ca-featured": false, "x-ca-label": "Auto strategy", "x-ca-group": "Auto Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "perPage": "Per Page", "uniform": "Uniform" } }, "AutoPadding": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Padding to add around detected content, using the selected measurement unit. Takes effect when `CropMode` is set to `Auto`.", "default": 0, "x-ca-featured": false, "x-ca-label": "Auto padding", "x-ca-group": "Auto Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "Anchor": { "enum": [ "center", "topleft", "top", "topright", "left", "right", "bottom", "bottomright" ], "type": "string", "description": "Anchor position to place the crop rectangle when crop height and crop width are defined.", "default": "center", "x-ca-featured": false, "x-ca-label": "Anchor", "x-ca-group": "Size Crop Mode", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "center": "Center", "topleft": "Top Left", "top": "Top", "topright": "Top Right", "left": "Left", "right": "Right", "bottom": "Bottom", "bottomright": "Bottom Right" } }, "VerticalMargin": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Top and bottom margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.", "default": 1, "x-ca-featured": false, "x-ca-label": "Vertical margin", "x-ca-group": "Margins Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "HorizontalMargin": { "maximum": 30000, "minimum": 0, "type": "number", "description": "Left and right margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.", "default": 1, "x-ca-featured": false, "x-ca-label": "Horizontal margin", "x-ca-group": "Margins Crop Mode", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30000" } }, "DeleteBlankPages": { "type": "boolean", "description": "Automatically detect and delete blank pages.", "default": false, "x-ca-featured": false, "x-ca-label": "Delete Blank Pages", "x-ca-group": "Document", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Wysiwyg": { "type": "boolean", "description": "Persist exact formatting using text boxes.", "default": false, "x-ca-featured": false, "x-ca-label": "Exact Formatting", "x-ca-group": "Word", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OcrMode": { "enum": [ "auto", "force", "never" ], "type": "string", "description": "Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.", "default": "auto", "x-ca-featured": false, "x-ca-label": "OCR Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "force": "Force", "never": "Never" } }, "OcrEngine": { "enum": [ "native", "tesseract" ], "type": "string", "description": "Select the OCR engine to use for text recognition. Each engine may produce slightly different results. If `Tesseract` is selected, the `OcrLanguage` property must be explicitly set, as automatic language detection is not supported.", "default": "native", "x-ca-featured": false, "x-ca-label": "OCR Engine", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "native": "Native", "tesseract": "Tesseract" } }, "Annotations": { "enum": [ "textBox", "comment", "none" ], "type": "string", "description": "Set how PDF annotations are handled in the DOCX output: choose `textBox` to place each annotation as an editable text box near its anchor, `comment` to convert annotations into Word comments attached to the relevant text, or `none` to omit all annotations from the result.", "default": "textBox", "x-ca-featured": false, "x-ca-label": "Annotations", "x-ca-group": "Word", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "textBox": "TextBox", "comment": "Comment", "none": "None" } }, "DocumentType": { "enum": [ "auto", "invoice", "receipt", "contract", "identification", "financial", "form", "manual" ], "type": "string", "description": "The `DocumentType` parameter specifies the type of document you're processing, enabling the AI to precisely extract structured data based on the selected document category. Selecting the correct document type improves extraction accuracy by applying optimized data extraction rules tailored for each category. Choose manual if you prefer to exclusively define `CustomExtractionData` parameter.\r\n\r\nSelect the DocumentType that matches your document:\r\n\r\n- **Auto** - Attempts to identify the document as one of the listed types and applies the corresponding extraction rules.\r\n\r\n- **Invoice** - Extract structured data from invoices, including invoice number, dates, totals, vendor details, and line items.\r\n\r\n- **Receipt** - Optimized extraction for payment receipts, capturing dates, totals, vendor details, and payment methods.\r\n\r\n- **Contract** - Captures critical details from contracts or agreements, including parties involved, dates, terms, and conditions.\r\n\r\n- **Identification** - Designed for identification documents like passports, driver's licenses, or national ID cards, extracting names, dates, document numbers, and other identifying information.\r\n\r\n- **Financial** - Specifically targets financial documents, including bank statements and transaction records, extracting transaction dates, amounts, balances, and descriptions.\r\n\r\n- **Form** - Extracts structured data from standard forms containing predefined fields, ideal for surveys, applications, and questionnaires.\r\n\r\n- **Manual** - Disables predefined AI document extraction presets. Only manually configured extraction parameters are used, giving full control to the user.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Document Type", "x-ca-group": "AI Detection Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Automatically Detect Document Type", "invoice": "Invoice", "receipt": "Receipt or Payment Slip", "contract": "Contract / Agreement", "identification": "Identification Document (ID, passport, etc.)", "financial": "Bank Statement / Transaction Records", "form": "Form with Structured Fields", "manual": "Custom Extraction Only" } }, "CustomExtractionData": { "type": "string", "description": "A JSON array defining specific values to extract.\r\n\r\n#### Example JSON\r\n\r\n```json\r\n[\r\n {\r\n \"FieldName\": \"TotalResult\",\r\n \"Extract\": \"total price\"\r\n },\r\n {\r\n \"FieldName\": \"ServiceName\",\r\n \"Extract\": \"most expensive service name\"\r\n }\r\n]\r\n```", "x-ca-featured": false, "x-ca-label": "Custom Extraction Data", "x-ca-group": "AI Detection Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "MinimumConfidence": { "maximum": 0.99, "minimum": 0.01, "type": "number", "description": "Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.", "default": 0.5, "x-ca-featured": false, "x-ca-label": "Minimum confidence", "x-ca-group": "AI Detection Options", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.01", "to": "0.99" } }, "IncludeAnnotationAttachments": { "type": "boolean", "description": "Include attachments embedded as page-level file attachment annotations", "default": true, "x-ca-featured": false, "x-ca-label": "Include Annotation Attachments", "x-ca-group": "Image", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "MinimumImageWidth": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "Set minimum image width in pixels. Images narrower than this value are ignored.", "default": 10, "x-ca-featured": false, "x-ca-label": "Minimum Image Width", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } }, "MinimumImageHeight": { "maximum": 1000, "minimum": 0, "type": "integer", "description": "Set minimum image height in pixels. Images shorter than this value are ignored.", "default": 10, "x-ca-featured": false, "x-ca-label": "Minimum Image Height", "x-ca-group": "Image", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "1000" } }, "IncludeAlternateNames": { "type": "boolean", "description": "Include alternate field names (/TU) from the PDF as tooltips in the FDF output.", "default": false, "x-ca-featured": false, "x-ca-label": "Include alternate names", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FdfFile": { "type": "string", "description": "Specifies the FDF file that contains structured form data. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "FDF file", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "fdf" ] }, "FlattenControls": { "type": "boolean", "description": "Prevent form controls such as text fields, checkboxes, and dropdowns from being edited by converting them into static page content while preserving their original appearance in the PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Controls", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FlattenWidgets": { "type": "boolean", "description": "Prevent widget annotations such as buttons, list boxes, and signature fields from being interactive by converting them into static page content while preserving their original appearance in the PDF.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Widgets", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FlattenText": { "type": "boolean", "description": "Prevent text selection, copying, and extraction by turning the textual symbols into vectorial paths to make the PDF read-only while preserving the original vectorial PDF quality.", "default": true, "x-ca-featured": false, "x-ca-label": "Flatten Text", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ImageFile": { "type": "string", "description": "Specifies the image file to use as watermark. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "Image file", "x-ca-group": "Watermark", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "jpg", "jpeg", "png", "tiff" ] }, "Opacity": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Specifies watermark opacity level.", "default": 100, "x-ca-featured": false, "x-ca-label": "Opacity level", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "100" } }, "Style": { "enum": [ "stamp", "watermark" ], "type": "string", "description": "Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.", "default": "watermark", "x-ca-featured": true, "x-ca-label": "Watermark style", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "stamp": "Stamp", "watermark": "Watermark" } }, "GoToLink": { "type": "string", "description": "Specifies the web address to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to web link", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "GoToPage": { "type": "string", "description": "Specifies the page number to go when the watermark is clicked.", "x-ca-featured": false, "x-ca-label": "Go to page", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "PageRotation": { "type": "boolean", "description": "Specifies whether the watermark should respect the PDF page rotation. When enabled, the watermark is rotated together with the page. When disabled, the watermark is placed ignoring page rotation.", "default": false, "x-ca-featured": false, "x-ca-label": "Use page rotation", "x-ca-group": "Watermark", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PageBox": { "enum": [ "mediabox", "trimbox", "bleedbox", "cropbox" ], "type": "string", "description": "Specifies the PDF page box used as the reference area for applying the watermark.", "default": "mediabox", "x-ca-featured": false, "x-ca-label": "PageBox", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "mediabox": "MediaBox", "trimbox": "TrimBox", "bleedbox": "BleedBox", "cropbox": "CropBox" } }, "HorizontalAlignment": { "enum": [ "left", "center", "right" ], "type": "string", "description": "Specifies the horizontal watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Horizontal watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "left": "Left", "center": "Center", "right": "Right" } }, "VerticalAlignment": { "enum": [ "top", "center", "bottom" ], "type": "string", "description": "Specifies the vertical watermark alignment.", "default": "center", "x-ca-featured": false, "x-ca-label": "Vertical watermark alignment", "x-ca-group": "Size & Position", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "top": "Top", "center": "Center", "bottom": "Bottom" } }, "OffsetX": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the X-axis. Positive values move the watermark to the right, while negative values move it to the left, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in X axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "OffsetY": { "maximum": 10000, "minimum": -10000, "type": "number", "description": "Specifies the watermark offset along the Y-axis. Positive values move the watermark downward, while negative values move it upward, using the selected `MeasurementUnit`.", "x-ca-featured": false, "x-ca-label": "Watermark offset in Y axis", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "-10000", "to": "10000" } }, "CropTo": { "enum": [ "BoundingBox", "TrimBox", "MediaBox", "ArtBox", "BleedBox" ], "type": "string", "description": "Defines the options for cropping the page.", "default": "BoundingBox", "x-ca-featured": false, "x-ca-label": "Crop to box", "x-ca-group": "PDF", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "BoundingBox": "Bounding Box", "TrimBox": "Trim Box", "MediaBox": "Media Box", "ArtBox": "Art Box", "BleedBox": "Bleed Box" } }, "FitToSize": { "type": "boolean", "description": "Gets or sets whether to scale the output image to fit within both ImageWidth and ImageHeight while maintaining the aspect ratio. When enabled, the image is sized to fit the more restrictive dimension. Requires both width and height to be specified.", "default": false, "x-ca-featured": false, "x-ca-label": "Fit to size", "x-ca-group": "JPG Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BitDepth": { "enum": [ "default", "1", "2", "4", "8", "16" ], "type": "string", "description": "Set the number of bits per color channel in the output image. Higher values improve color precision and gradient smoothness but increase file size.", "default": "default", "x-ca-featured": false, "x-ca-label": "Bit depth", "x-ca-group": "JPG Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "1": "1 bit", "2": "2 bits", "4": "4 bits", "8": "8 bits", "16": "16 bits" } }, "RemoveDuplicateFonts": { "type": "boolean", "description": "Do not include the same fonts from source PDFs while merging.", "default": false, "x-ca-featured": true, "x-ca-label": "Remove duplicate fonts", "x-ca-group": "Merge", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "BookmarksToc": { "enum": [ "disabled", "filename", "title" ], "type": "string", "description": "Adds a top-level bookmark for each file, using the filename or PDF title from metadata.", "default": "disabled", "x-ca-featured": true, "x-ca-label": "Add bookmarks TOC", "x-ca-group": "Merge", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "disabled": "Disabled", "filename": "File Name", "title": "Title" } }, "OutputType": { "enum": [ "pdf", "txt" ], "type": "string", "description": "This property is used to determine how the OCR layer should be returned. If the output type is PDF, the OCR layer will be embedded into the PDF file. Alternatively, if a text output is selected, the OCR layer will be returned as a text file.", "default": "pdf", "x-ca-featured": false, "x-ca-label": "Output Type", "x-ca-group": "Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "pdf": "PDF file", "txt": "Text file" } }, "PageSegmentationMode": { "enum": [ "sparseText", "sparseTextOsd", "auto", "autoOsd", "singleLine", "singleColumn", "singleWord" ], "type": "string", "description": "The **PageSegmentationMode** parameter specifies how the OCR engine segments and interprets text within PDF documents. Choosing the appropriate mode enhances OCR accuracy by aligning closely with your document's layout and structure.\r\n\r\nSelect one of the available modes to control text detection and layout analysis:\r\n- **SparseText** - Detects as much text as possible without enforcing any specific order. Suitable for documents containing scattered or fragmented text.\r\n- **SparseTextOsd** - Similar to SparseText, but also includes orientation and script detection (OSD). Useful for documents with rotated text or multiple scripts and languages.\r\n- **Auto** - Automatically selects the best segmentation mode based on document content. Ideal for general documents with mixed or unknown layouts.\r\n- **AutoOsd** - Combines automatic segmentation with orientation and script detection. Recommended for documents with uncertain text orientation or multilingual content.\r\n- **SingleColumn** - Assumes a single column of text with varying text sizes. Best suited for straightforward layouts.\r\n- **SingleLine** - Treats the entire image as a single line of text. Useful for single-line labels, banners, or narrow text snippets.\r\n- **SingleWord** - Treats the entire image as a single word. Ideal for recognizing isolated words or short phrases.", "default": "sparseText", "x-ca-featured": false, "x-ca-label": "Page Segmentation Mode", "x-ca-group": "OCR", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "sparseText": "Sparse Text", "sparseTextOsd": "Sparse Text Osd", "auto": "Auto", "autoOsd": "Auto Osd", "singleLine": "Single Line", "singleColumn": "Single Column", "singleWord": "Single Word" } }, "Resolution": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Defines the resolution for output document, measured in dots per inch (DPI). Higher DPI values produce better image quality but result in larger file sizes.", "default": 300, "x-ca-featured": false, "x-ca-label": "Resolution", "x-ca-group": "Options", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "PdfCreator": { "type": "string", "description": "Provide a value to customize the PDF creator. Otherwise, the default document creator will be used. Use single quotes and a space (' ') to remove the creator.", "x-ca-featured": false, "x-ca-label": "PDF creator", "x-ca-group": "PDF Output", "x-ca-type": "String", "x-ca-representation": "Default" }, "OverlayFile": { "type": "string", "description": "Specifies the PDF file to use as overlay. Value can be URL or file content.", "format": "binary", "x-ca-featured": true, "x-ca-label": "Overlay PDF file", "x-ca-group": "Watermark", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "pdf" ] }, "OverlayPage": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "Specifies the page to use as overlay from the OverlayFile file.", "default": 1, "x-ca-featured": false, "x-ca-label": "Overlay PDF page", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "InvoiceFormat": { "enum": [ "none", "facturX", "zugferd1", "zugferd2" ], "type": "string", "description": "Selects the e-invoice format to embed. Choosing any e-invoice format overrides the selected PDF/A version and outputs PDF/A-3. Requires a valid structured invoice XML.", "default": "none", "x-ca-featured": false, "x-ca-label": "Invoice data format", "x-ca-group": "Invoice", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "No e-invoice embedding", "facturX": "Factur-X XML", "zugferd1": "ZUGFeRD 1.0 XML", "zugferd2": "ZUGFeRD 2.0 XML" } }, "InvoiceFile": { "type": "string", "description": "Specifies the structured invoice XML (ZUGFeRD / Factur-X) to embed for hybrid-invoice compatibility. Required when `InvoiceFormat` is enabled.", "format": "binary", "x-ca-featured": false, "x-ca-label": "Invoice File", "x-ca-group": "Invoice", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "xml" ] }, "TextRecoveryMode": { "enum": [ "auto", "always", "never" ], "type": "string", "description": "Specifies how text is recovered from PDFs that use non-standard encodings (NSE). When set to `auto`, the converter detects and recovers text only when needed; `always` forces NSE recovery for all text; and `never` disables it.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Text Recovery Mode", "x-ca-group": "PowerPoint", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "always": "Always", "never": "Never" } }, "TrimSize": { "enum": [ "default", "a2", "a3", "a4", "a5", "a6", "letter", "legal", "custom" ], "type": "string", "description": "Page size to enforce on every page. `Default` keeps each page\u2019s current size; `Custom` activates `TrimWidth` / `TrimHeight`.", "default": "default", "x-ca-featured": false, "x-ca-label": "Trim size", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "default": "Default", "a2": "A2", "a3": "A3", "a4": "A4", "a5": "A5", "a6": "A6", "letter": "Letter", "legal": "Legal", "custom": "Custom" } }, "TrimWidth": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.", "x-ca-featured": false, "x-ca-label": "Trim width", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "TrimHeight": { "maximum": 1000, "minimum": 10, "type": "integer", "description": "Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.", "x-ca-featured": false, "x-ca-label": "Trim height", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "10", "to": "1000" } }, "BleedTop": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added above the Trim Box (top edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area at the top for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed top", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedRight": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added to the right of the Trim Box (right edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area on the right for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed right", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedBottom": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added below the bottom of the Trim Box (bottom edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area at the bottom for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed bottom", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedLeft": { "maximum": 30, "minimum": 0, "type": "integer", "description": "Thickness of bleed added to the left of the Trim Box (left edge). Specify a single numeric value in millimeters (mm) to extend the page beyond the trim area on the left for full-bleed printing.", "default": 3, "x-ca-featured": false, "x-ca-label": "Bleed left", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "30" } }, "BleedMode": { "enum": [ "none", "mirror", "stretch" ], "type": "string", "description": "Defines how additional bleed content is generated when bleed is requested. Choose `Mirror` to mirror page content outward into the bleed area for a realistic full-bleed preview, `Stretch` to extend edge pixels into the bleed, or `None` to disable bleed fabrication.", "default": "none", "x-ca-featured": false, "x-ca-label": "Bleed mode", "x-ca-group": "Bleed, Trim & Margins", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "mirror": "Mirror", "stretch": "Stretch" } }, "TrimMarks": { "type": "boolean", "description": "Adds crop marks outside the Bleed Box.", "default": false, "x-ca-featured": false, "x-ca-label": "Trim marks", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RegistrationMarks": { "type": "boolean", "description": "Adds registration targets centred \u22653mm outside Bleed Box on each edge.", "default": false, "x-ca-featured": false, "x-ca-label": "Registration marks", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Slug": { "type": "string", "description": "Text placed on the bottom of the Media Box (e.g., printed file name, order number, customer information, etc.).", "x-ca-featured": false, "x-ca-label": "Slug", "x-ca-group": "Printing Marks", "x-ca-type": "String", "x-ca-representation": "Default" }, "TintBars": { "type": "boolean", "description": "Adds grayscale and color control bars at the top of the page, positioned outside the Trim Box.", "default": false, "x-ca-featured": false, "x-ca-label": "Tint bars", "x-ca-group": "Printing Marks", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OutputIntent": { "enum": [ "none", "fogra39", "fogra51", "gracol2013", "swop2013", "japancolor2011", "custom" ], "type": "string", "description": "Embeds ICC profile as PDF OutputIntent. Choosing `Custom` requires `OutputIntentIccFile` to be provided.", "default": "none", "x-ca-featured": false, "x-ca-label": "Output intent", "x-ca-group": "Color Management", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "none": "None", "fogra39": "FOGRA39 (ISO Coated v2)", "fogra51": "FOGRA51 (PSO Coated v3)", "gracol2013": "GRACoL 2013 (CGATS 21_CRPC6)", "swop2013": "SWOP 2013 (CGATS 21_CRPC5)", "japancolor2011": "Japan Color 2011 Coated", "custom": "Custom" } }, "OutputIntentIccFile": { "type": "string", "description": "Embeds ICC profile as PDF OutputIntent. Required when `OutputIntent` is set to `custom`.", "format": "binary", "x-ca-featured": false, "x-ca-label": "Output Intent Icc File", "x-ca-group": "Color Management", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "icc" ] }, "DownsampleImages": { "type": "boolean", "description": "Reduces images above resolution to save file size.", "default": false, "x-ca-featured": false, "x-ca-label": "Downsample images", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "EncryptionAlgorithm": { "enum": [ "Standard40Bit", "Standard128Bit", "Aes128Bit", "Aes256Bit" ], "type": "string", "description": "Sets the encryption algorithm.", "default": "Aes256Bit", "x-ca-featured": false, "x-ca-label": "Encryption algorithm", "x-ca-group": "Encryption", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Standard40Bit": "40-bit RC4 algorithm. Acrobat 3 (PDF 1.1) and above", "Standard128Bit": "128-bit RC4 algorithm. Acrobat 5 (PDF 1.4) and above", "Aes128Bit": "128-bit AES algorithm. Acrobat 7 (PDF 1.6) and above", "Aes256Bit": "256-bit AES algorithm. PDF 2.0" } }, "EncryptMeta": { "type": "boolean", "description": "Encrypt metadata of PDF file.", "default": false, "x-ca-featured": false, "x-ca-label": "Encrypt Meta", "x-ca-group": "Encryption", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "UserPassword": { "type": "string", "description": "Sets the user password (also known as a document open password) in the output PDF document. Users will be asked to enter this password before Acrobat Reader allows them to view the PDF document.", "x-ca-featured": true, "x-ca-label": "User Password", "x-ca-group": "Encryption", "x-ca-type": "String", "x-ca-representation": "Default" }, "OwnerPassword": { "type": "string", "description": "Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don\u2019t need a password to open the document. They do need a password to change the restrictions the owner set.", "x-ca-featured": true, "x-ca-label": "Owner Password", "x-ca-group": "Document Permissions", "x-ca-type": "String", "x-ca-representation": "Default" }, "RespectOwnerPassword": { "type": "boolean", "description": "Enable the property if you want to respect the document's owner password and permissions. If disabled - the old owner's password and permissions will be removed by default. Setting this property requires you to enter the correct owner's password into the Password property for protected documents.", "default": false, "x-ca-featured": false, "x-ca-label": "Respect owner password", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PreservePermissions": { "type": "boolean", "description": "Enable the property if you want to keep the document permissions unchanged. It requires you to specify the OwnerPassword. If enabled, the document permission properties will be ignored.", "default": false, "x-ca-featured": false, "x-ca-label": "Preserve document permissions", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AllowEverything": { "type": "boolean", "description": "Enable or disable all permissions. The specific permissions listed below overrides this property.", "default": false, "x-ca-featured": false, "x-ca-label": "Allow everything", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "AssembleDocument": { "type": "boolean", "description": "Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.", "default": false, "x-ca-featured": false, "x-ca-label": "Assemble document", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "CopyContents": { "type": "boolean", "description": "Enable or disable copy or extract text and graphics from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Copy contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ModifyContents": { "type": "boolean", "description": "Enable or disable changing the contents of the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Modify contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExtractContents": { "type": "boolean", "description": "Enable or disable extract text and graphics.", "default": false, "x-ca-featured": false, "x-ca-label": "Extract contents", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ModifyAnnotations": { "type": "boolean", "description": "Enable or disable adding or modifying text annotations and fill in interactive form fields.", "default": false, "x-ca-featured": false, "x-ca-label": "Modify annotations", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FillFormFields": { "type": "boolean", "description": "Enable or disable fill-in existing interactive form fields, including signature fields.", "default": false, "x-ca-featured": false, "x-ca-label": "Fill form fields", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PrintDocument": { "type": "boolean", "description": "Enable or disable document printing.", "default": false, "x-ca-featured": false, "x-ca-label": "Print document", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PrintFaithfulCopy": { "type": "boolean", "description": "Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.", "default": false, "x-ca-featured": false, "x-ca-label": "Print faithful copy", "x-ca-group": "Document Permissions", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ContextSize": { "enum": [ "balanced", "page" ], "type": "string", "description": "Defines how the AI engine processes the document in terms of context.\r\n\r\nWhen the `ContextSize` parameter is set to `Page`, each page is processed independently, without context from other pages. This mode is useful when a document contains structured or repetitive data (such as tables with rows of values), or when a high volume of detections is expected. By limiting context to a single page, the AI avoids confusion from unrelated content and ensures accuracy per page.\r\n\r\nWhen the `ContextSize` parameter is set to `Balanced`, the AI maintains context across multiple pages while still optimizing processing efficiency. This mode is recommended for large or multi-page documents where relationships between sections matter, and it also provides improved performance for large documents.", "default": "balanced", "x-ca-featured": false, "x-ca-label": "Context Size", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "balanced": "Balanced", "page": "Page" } }, "RedactionColor": { "type": "string", "description": "Specifies the color used to mask redacted text, accepting formats such as Hexadecimal (e.g., `#FFFFFF` for white or `#FF5733` for orange), RGB with an optional alpha channel (e.g., `255,255,255` for white or `255,255,255`), and named colors (e.g., `white`, `red`, `blue`).", "x-ca-featured": false, "x-ca-label": "Redaction Color", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Color", "x-ca-representation": "Default" }, "RedactionThickness": { "maximum": 2, "minimum": 0.5, "type": "number", "description": "The RedactionThickness property controls the height of the redaction stroke line relative to the original line height.\r\n\r\n- A value of 1 means the stroke height matches the original line height.\r\n- Values less than 1 (e.g., 0.5) reduce the stroke height.\r\n- Values greater than 1 (e.g., 1.5 or 2) increase the stroke height.", "default": 1, "x-ca-featured": false, "x-ca-label": "Redaction Thickness", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0.5", "to": "2" } }, "PII": { "type": "boolean", "description": "**Personally Identifiable Information (PII)** - Detects and redacts common personal identifiers, including names, email addresses, phone numbers, birthdates, and home addresses.", "default": false, "x-ca-featured": false, "x-ca-label": "Personally Identifiable Information (PII)", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "PHI": { "type": "boolean", "description": "**Patient Health Information (PHI)** - Detects health-related information such as patient names, medical records, insurance details, and prescription data.", "default": false, "x-ca-featured": false, "x-ca-label": "Patient Health Information (PHI)", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Financial": { "type": "boolean", "description": "**Financial Data** - Focuses on financial records, including credit card numbers, bank account numbers, financial transaction details, etc.", "default": false, "x-ca-featured": false, "x-ca-label": "Financial Data", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Legal": { "type": "boolean", "description": "**Legal and Contractual Data** - Detects legal and contractual terms, including case numbers, legal clauses, signatures, and confidential agreements.", "default": false, "x-ca-featured": false, "x-ca-label": "Legal and Contractual Data", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Confidential": { "type": "boolean", "description": "**Legal and Contractual Data** - Detects proprietary business information, contracts and agreements, internal communications, trade secrets, intellectual property details, and sensitive corporate data.", "default": false, "x-ca-featured": false, "x-ca-label": "Confidential", "x-ca-group": "Custom Redaction Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RedactionData": { "type": "string", "description": "A JSON array defining specific values for redaction. Supports three methods:\r\n\r\n- **Text** \u2013 Exact text to be redacted.\r\n- **Regex** \u2013 *Escaped* regular expression patterns for flexible text matching.\r\n- **Detect** \u2013 AI-based detection using a description of what to find.\r\n\r\nIf `RedactionData` is passed, it forces: `Preset` is set to `manual`, and all built-in detection options (such as `PII`, `PHI`, `Financial`, `Legal`, `Confidential`) are disabled. In this mode, only the values defined in RedactionData are applied.\r\n\r\n#### Example JSON\r\n\r\n```json\r\n[\r\n {\r\n \"Text\": \"john@domain.com\"\r\n },\r\n {\r\n \"Detect\": \"Bank account number\"\r\n },\r\n {\r\n \"Regex\": \"\\\\b100\\\\s*(\u20ac|\\\\$)\\\\b\"\r\n }\r\n]\r\n```", "x-ca-featured": false, "x-ca-label": "Text to Mask JSON Payload", "x-ca-group": "Custom Redaction Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "FixFontEncoding": { "type": "boolean", "description": "Repairs broken text extraction in PDFs where copied or extracted text appears as garbled or unreadable characters, even though the document displays correctly on screen. Fixes missing or invalid Unicode mappings in embedded fonts.", "default": false, "x-ca-featured": false, "x-ca-label": "Fix font encoding", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Angle": { "enum": [ "0", "90", "180", "270" ], "type": "string", "description": "Rotates page(s) by selected degree.", "default": "90", "x-ca-featured": false, "x-ca-label": "Rotation Angle", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "0": "0 degree (normal)", "90": "90 degree", "180": "180 degree", "270": "270 degree" } }, "SplitByPattern": { "type": "string", "description": "A comma-separated sequence of positive integers defining the size of each split segment. The PDF will be divided into consecutive chunks whose page counts follow the given pattern, repeating it until all pages are consumed. For a 10-page PDF with `SplitByPattern = 3,2`, the output will be four documents containing pages `[1-3]`, `[4-5]`, `[6-8]`, and `[9-10]` (pattern repeats: 3,2,3,2).\r\n\r\n", "default": "1", "x-ca-featured": true, "x-ca-label": "Split by pattern", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "SplitByRange": { "type": "string", "description": "Specify exactly which pages to extract by listing single pages or inclusive ranges. The API will emit one PDF per entry, in the order given. For a 10-page file with `SplitByRange = 1-3,5,7-9`, you receive three PDFs containing pages `[1\u20133]`, `[5]`, and `[7\u20139]`.", "x-ca-featured": true, "x-ca-label": "Split by range", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "SplitByTextPattern": { "type": "string", "description": "Splits the PDF into separate output files by starting a new document at each page whose text matches the specified regular expression. With `SplitByTextPattern = Chapter\\s+\\d+`, the PDF will be split at every page where \u201cChapter 1\u201d, \u201cChapter 2\u201d, etc., appear. If \u201cChapter 1\u201d is on page 1, \u201cChapter 2\u201d on page 10, and \u201cChapter 3\u201d on page 20 of a 25-page PDF, you\u2019ll get four files containing pages `[1\u20139]`, `[10\u201319]`, `[20\u201325]`, and any pages after the last match (if present).", "x-ca-featured": true, "x-ca-label": "Split by text pattern", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default" }, "SplitByBookmark": { "type": "boolean", "description": "Automatically splits a source PDF into individual documents, creating a new file at every bookmarked page. When nested bookmarks are present, splitting occurs at the deepest (child) level, and each output file is named to reflect the full bookmark hierarchy - for example: `ParentBookmark-ChildBookmark.pdf`. When the source PDF has no bookmarks, the original document is returned unchanged as `no-bookmarks.pdf`.", "default": false, "x-ca-featured": true, "x-ca-label": "Split by bookmark", "x-ca-group": "Split", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExtractPages": { "type": "string", "description": "Specify a comma-separated list of pages or inclusive ranges `ExtractPages = 1,3-5,7` to pull out from the source PDF. The API will emit one PDF per entry, each containing exactly the pages defined.", "x-ca-featured": true, "x-ca-label": "Extract pages", "x-ca-group": "Split", "x-ca-type": "String", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "2000" } }, "MergeOutput": { "type": "boolean", "description": "When set to `true`, all split output files (whether defined by page ranges, custom ranges, or text-pattern segments) will be merged into a single PDF. By default `false`, the API returns one PDF per specified range.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Merge output", "x-ca-group": "Merge", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "Text": { "type": "string", "description": "Specifies the text to use as watermark. The list of supported variables: \r\n\r\n* ```%PAGE%``` - current page number\r\n* ```%PAGES%``` - total number of pages\r\n* ```%FILENAME%``` - name of the file\r\n* ```%WEEKDAY%``` - full weekday name\r\n* ```%WEEKDAY_SHORT%``` - abbreviated weekday name\r\n* ```%MONTH%``` - month number (1-12)\r\n* ```%MONTHNAME%``` - full month name\r\n* ```%MONTHNAME_SHORT%``` - abbreviated month name \r\n* ```%YEAR%``` - year with century (YYYY)\r\n* ```%YEAR_SHORT%``` - year without century (YY)\r\n* ```%DAY%``` - day of month\r\n* ```%DAY_YEAR%``` - day of the year (1 -366)\r\n* ```%HOUR%``` - hour (01- 12)\r\n* ```%HOURS%``` - hour (00-23)\r\n* ```%MINUTES%``` - minutes (00-59)\r\n* ```%SECONDS%``` - seconds (00-59)\r\n* ```%AMPM%``` - AM PM\r\n* ```%DATE%``` - local date representation\r\n* ```%TIME%``` - local time representation\r\n* ```%DATETIME%``` - local date and time \r\n* ```%AUTHOR%``` - document Author\r\n* ```%TITLE%``` - document Title\r\n* ```%SUBJECT%``` - document Subject\r\n* ```%KEYWORDS%``` - document Keywords\r\n* ```%N%``` - new line", "x-ca-featured": true, "x-ca-label": "Watermark text", "x-ca-group": "Watermark", "x-ca-type": "String", "x-ca-representation": "Default" }, "FontSize": { "maximum": 200, "minimum": 1, "type": "integer", "description": "Specifies the watermark font size.", "default": 40, "x-ca-featured": false, "x-ca-label": "Watermark font size", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "1", "to": "200" } }, "TextRenderingMode": { "enum": [ "filltext", "stroketext", "fillstroke", "invisible" ], "type": "string", "description": "Specifies the text rendering mode.", "default": "fillstroke", "x-ca-featured": false, "x-ca-label": "Text rendering mode", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "filltext": "Fill text without stroke", "stroketext": "Stroke text without fill", "fillstroke": "Fill and stroke", "invisible": "Invisible" } }, "FontColor": { "type": "string", "description": "Specifies the watermark font color.", "x-ca-featured": false, "x-ca-label": "Watermark font color", "x-ca-group": "Watermark", "x-ca-type": "Color", "x-ca-representation": "Default" }, "StrokeColor": { "type": "string", "description": "Specifies font stroke color.", "x-ca-featured": false, "x-ca-label": "Stroke color", "x-ca-group": "Watermark", "x-ca-type": "Color", "x-ca-representation": "Default" }, "StrokeWidth": { "maximum": 200, "minimum": 0, "type": "integer", "description": "Specifies the stroke width.", "default": 1, "x-ca-featured": false, "x-ca-label": "Stroke width", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "200" } }, "FontName": { "enum": [ "arial", "bahnschrift", "calibri", "cambria", "consolas", "constantia", "courierNew", "georgia", "tahoma", "timesNewRoman", "verdana" ], "type": "string", "description": "Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list.", "default": "arial", "x-ca-featured": false, "x-ca-label": "Watermark font name", "x-ca-group": "Watermark", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "arial": "Arial", "bahnschrift": "Bahnschrift", "calibri": "Calibri", "cambria": "Cambria", "consolas": "Consolas", "constantia": "Constantia", "courierNew": "Courier New", "georgia": "Georgia", "tahoma": "Tahoma", "timesNewRoman": "Times New Roman", "verdana": "Verdana" } }, "Width": { "maximum": 10000, "minimum": 0, "type": "number", "description": "Specifies the width of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the width is unspecified.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text box width", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "10000" } }, "Height": { "maximum": 10000, "minimum": 0, "type": "number", "description": "Specifies the height of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the height is unspecified.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text box height", "x-ca-group": "Size & Position", "x-ca-type": "Double", "x-ca-representation": "Default", "x-ca-range": { "from": "0", "to": "10000" } }, "LineSpacing": { "maximum": 30, "minimum": -30, "type": "integer", "description": "Specifies the watermark text line spacing.", "default": 0, "x-ca-featured": false, "x-ca-label": "Watermark text line spacing", "x-ca-group": "Watermark", "x-ca-type": "Integer", "x-ca-representation": "Default", "x-ca-range": { "from": "-30", "to": "30" } }, "FontEmbed": { "type": "boolean", "description": "Specifies whether fonts should be embedded.", "default": true, "x-ca-featured": false, "x-ca-label": "Embed watermark font", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "FontSubset": { "type": "boolean", "description": "Specifies whether fonts should be subset.", "default": true, "x-ca-featured": false, "x-ca-label": "Font subset", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TiffType": { "enum": [ "monochromeg3", "monochromeg32d", "monochromeg4", "monochromelzw", "monochromepackbits" ], "type": "string", "description": "Set TIFF FAX type.", "default": "monochromeg4", "x-ca-featured": false, "x-ca-label": "TIFF Type", "x-ca-group": "TIFF Output", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "monochromeg3": "Monochrome - G3 fax encoding with EOLs", "monochromeg32d": "Monochrome - 2-D G3 fax encoding", "monochromeg4": "Monochrome - G4 fax encoding", "monochromelzw": "Monochrome - LZW-compatible compression", "monochromepackbits": "Monochrome - PackBits compression" } }, "IncludeFormatting": { "type": "boolean", "description": "Persist formatting while extracting text. Only works when RemoveHeadersFooters and RemoveFootnotes properties are disabled.", "default": false, "x-ca-featured": false, "x-ca-label": "Include Formatting", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SplitPages": { "type": "boolean", "description": "Split each page to different result file.", "default": false, "x-ca-featured": false, "x-ca-label": "Split Pages", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveHeadersFooters": { "type": "boolean", "description": "Remove headers and footers from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Headers and Footers", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveFootnotes": { "type": "boolean", "description": "Remove footnotes from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Footnotes", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "RemoveTables": { "type": "boolean", "description": "Remove tables from the document.", "default": false, "x-ca-featured": false, "x-ca-label": "Remove Tables", "x-ca-group": "Text", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "SingleSheet": { "type": "boolean", "description": "Combine extracted tables into a single sheet.", "default": false, "x-ca-featured": false, "x-ca-label": "Single Sheet", "x-ca-group": "Excel", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ExpectedConformance": { "enum": [ "auto", "pdfA1a", "pdfA1b", "pdfA2a", "pdfA2b", "pdfA2u", "pdfA3a", "pdfA3b", "pdfA3u", "pdfA4", "pdfA4e", "pdfA4f" ], "type": "string", "description": "Set target PDF/A conformance. Validate against a specific version, or use `auto` to detect the document\u2019s claimed level.", "default": "auto", "x-ca-featured": true, "x-ca-label": "Expected PDF/A Conformance", "x-ca-group": "PDF/A", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Auto", "pdfA1a": "PDF/A-1a", "pdfA1b": "PDF/A-1b", "pdfA2a": "PDF/A-2a", "pdfA2b": "PDF/A-2b", "pdfA2u": "PDF/A-2u", "pdfA3a": "PDF/A-3a", "pdfA3b": "PDF/A-3b", "pdfA3u": "PDF/A-3u", "pdfA4": "PDF/A-4", "pdfA4e": "PDF/A-4e", "pdfA4f": "PDF/A-4f" } }, "PeppolTemplateFile": { "type": "string", "description": "Optional custom DOCX template used to render the Peppol invoice. The Peppol BIS Billing 3.0 (UBL) XML supplied as the source file is parsed and its values are substituted into the template's `{{placeholder}}` tokens. When this parameter is omitted, the bundled default template is used.\r\n\r\n#### Text placeholders\r\n\r\nInvoice identification:\r\n\r\n* `{{DocumentType}}` \u2014 human-readable document type, resolved from UBL `cbc:InvoiceTypeCode`: `380` \u2192 `INVOICE`, `381` \u2192 `CREDIT NOTE`, `384` \u2192 `CORRECTED INVOICE`. Other codes are emitted verbatim.\r\n* `{{InvoiceNumber}}` \u2014 UBL `cbc:ID` (e.g. `INV-2025-001`).\r\n* `{{IssueDate}}` \u2014 UBL `cbc:IssueDate` (e.g. `2025-03-12`).\r\n* `{{DueDate}}` \u2014 UBL `cbc:DueDate` (e.g. `2025-04-11`).\r\n* `{{Currency}}` \u2014 UBL `cbc:DocumentCurrencyCode` (e.g. `EUR`, `USD`).\r\n* `{{BuyerReference}}` \u2014 UBL `cbc:BuyerReference` (e.g. `PO-12345`).\r\n* `{{Note}}` \u2014 UBL `cbc:Note`.\r\n\r\nParties (supplier from `cac:AccountingSupplierParty`, customer from `cac:AccountingCustomerParty`):\r\n\r\n* `{{SupplierName}}` / `{{CustomerName}}` \u2014 `cac:PartyLegalEntity/cbc:RegistrationName`, falling back to `cac:PartyName/cbc:Name`.\r\n* `{{SupplierVatId}}` / `{{CustomerVatId}}` \u2014 first non-empty `cac:PartyTaxScheme/cbc:CompanyID`.\r\n* `{{SupplierAddress}}` / `{{CustomerAddress}}` \u2014 composed from `cac:PostalAddress` as `StreetName, CityName, PostalZone, Country` (empty parts skipped).\r\n\r\nContact (rendered inside `{{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}}`):\r\n\r\n* `{{SupplierContactName}}` / `{{CustomerContactName}}` \u2014 `cac:Contact/cbc:Name`.\r\n* `{{SupplierContactPhone}}` / `{{CustomerContactPhone}}` \u2014 `cac:Contact/cbc:Telephone`.\r\n* `{{SupplierContactEmail}}` / `{{CustomerContactEmail}}` \u2014 `cac:Contact/cbc:ElectronicMail`.\r\n\r\nTotals (from `cac:LegalMonetaryTotal` and `cac:TaxTotal`):\r\n\r\n* `{{TaxExclusiveAmount}}` \u2014 net total before tax.\r\n* `{{TaxAmount}}` \u2014 total VAT amount.\r\n* `{{PrepaidAmount}}` \u2014 amount already paid.\r\n* `{{PayableAmount}}` \u2014 final amount due.\r\n\r\nPayment (from `cac:PaymentMeans/cac:PayeeFinancialAccount`):\r\n\r\n* `{{PayeeIBAN}}` \u2014 account `cbc:ID`.\r\n* `{{PayeeAccountName}}` \u2014 account `cbc:Name`.\r\n\r\n#### Conditional sections\r\n\r\nWrap optional content in the template so it can be toggled via the `ShowContactDetails` and `ShowNote` parameters. The wrapper tags themselves are removed from the rendered output:\r\n\r\n* `{{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}}` \u2014 kept when `ShowContactDetails` is `true`; the whole block is removed when `false`.\r\n* `{{#IF ShowNote}} ... {{#ENDIF ShowNote}}` \u2014 kept when `ShowNote` is `true`; removed when `false`.\r\n\r\n#### Table placeholders\r\n\r\nPlace each table placeholder in a single cell of a one-row template table \u2014 the row is cloned for each item, preserving formatting.\r\n\r\n* `{{InvoiceLines}}` \u2014 one row per `cac:InvoiceLine`. Columns (in order): Description, Quantity, Unit Price, VAT %, Line Amount.\r\n* `{{VatBreakdown}}` \u2014 one row per `cac:TaxTotal/cac:TaxSubtotal`. Columns (in order):\r\n * VAT Category label \u2014 `VAT {percent}%` for rated categories (e.g. `VAT 21%`), or a descriptive label with UNTDID 5305 code for non-rated ones: `Standard rate (S)`, `Zero-rated (Z)`, `Exempt (E)`, `Reverse charge (AE)`, `Intra-community (K)`, `Export (G)`, `Out of scope (O)`, `Canary Islands IGIC (L)`, `Ceuta/Melilla IPSI (M)`.\r\n * Tax Amount with currency (e.g. `73.50 EUR`).\r\n * Rate % (e.g. `21%`, `8.5%`).\r\n * Taxable Amount.", "format": "binary", "x-ca-featured": false, "x-ca-label": "Peppol Template File", "x-ca-group": "Input", "x-ca-type": "File", "x-ca-representation": "Default", "x-ca-allowed-extensions": [ "docx" ] }, "ShowContactDetails": { "type": "boolean", "description": "When enabled, supplier and customer contact details (name, phone, email) are included in the rendered invoice; when disabled, the contact block is hidden.\r\n\r\nTakes effect by default when the bundled template is used. When a custom `PeppolTemplateFile` is supplied, the contact block must be wrapped with `{{#IF ShowContactDetails}} ... {{#ENDIF ShowContactDetails}}` for this parameter to have any effect.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Show contact details", "x-ca-group": "Input", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ShowNote": { "type": "boolean", "description": "When enabled, the invoice note is included in the rendered invoice; when disabled, the note block is hidden.\r\n\r\nTakes effect by default when the bundled template is used. When a custom `PeppolTemplateFile` is supplied, the note block must be wrapped with `{{#IF ShowNote}} ... {{#ENDIF ShowNote}}` for this parameter to have any effect.\r\n", "default": false, "x-ca-featured": false, "x-ca-label": "Show note", "x-ca-group": "Input", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "OverwriteTranslations": { "type": "boolean", "description": "When enabled, this option allows the API to re-translate strings that already have existing translations in the PO file. This is useful when updating outdated or low-quality translations.", "default": false, "x-ca-featured": true, "x-ca-label": "Overwrite Translations", "x-ca-group": "Options", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "TranslationContext": { "type": "string", "description": "Optional file-level context that guides the translation engine. Provide a short description of the product, audience, or domain. The context is applied to improve tone, terminology, and overall translation accuracy.", "x-ca-featured": true, "x-ca-label": "Translation Context", "x-ca-group": "AI Detection Options", "x-ca-type": "String", "x-ca-representation": "Default" }, "SourceLanguage": { "enum": [ "auto", "ar", "ca", "zh-cn", "zh-tw", "da", "nl", "en", "fi", "fr", "de", "el", "he", "hi", "id", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "uk", "vi", "th" ], "type": "string", "description": "Defines the source language for translation engine. Set concrete language or use `auto`, to let the engine detect the source language automatically.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Source Language", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Automatically Detect Language", "ar": "Arabic", "ca": "Catalan", "zh-cn": "Chinese Simplified", "zh-tw": "Chinese Traditional", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "he": "Hebrew", "hi": "Hindi", "id": "Indonesian", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "uk": "Ukrainian", "vi": "Vietnamese", "th": "Thai" } }, "TargetLanguage": { "enum": [ "auto", "ar", "ca", "zh-cn", "zh-tw", "da", "nl", "en", "fi", "fr", "de", "el", "he", "hi", "id", "ko", "it", "ja", "no", "pl", "pt", "ro", "ru", "sl", "es", "sv", "tr", "uk", "vi", "th" ], "type": "string", "description": "Sets the target language for translation. Use `auto` to retain the language already defined in the PO file, or choose a specific language to overwrite it.", "default": "auto", "x-ca-featured": false, "x-ca-label": "Target Language", "x-ca-group": "Options", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "auto": "Automatically Detect Language", "ar": "Arabic", "ca": "Catalan", "zh-cn": "Chinese Simplified", "zh-tw": "Chinese Traditional", "da": "Danish", "nl": "Dutch", "en": "English", "fi": "Finnish", "fr": "French", "de": "German", "el": "Greek", "he": "Hebrew", "hi": "Hindi", "id": "Indonesian", "ko": "Korean", "it": "Italian", "ja": "Japanese", "no": "Norwegian", "pl": "Polish", "pt": "Portuguese", "ro": "Romanian", "ru": "Russian", "sl": "Slovenian", "es": "Spanish", "sv": "Swedish", "tr": "Turkish", "uk": "Ukrainian", "vi": "Vietnamese", "th": "Thai" } }, "ConvertHiddenSlides": { "type": "boolean", "description": "Include hidden slides while converting.", "default": false, "x-ca-featured": false, "x-ca-label": "Convert hidden slides", "x-ca-group": "PowerPoint", "x-ca-type": "Bool", "x-ca-representation": "Default" }, "ConvertSpeakerNotes": { "enum": [ "Disabled", "SeparatePage", "PageComments" ], "type": "string", "description": "Choose how speaker notes will be converted.", "default": "Disabled", "x-ca-featured": false, "x-ca-label": "Convert speaker notes", "x-ca-group": "PowerPoint", "x-ca-type": "Collection", "x-ca-representation": "Dropdown", "x-ca-values": { "Disabled": "Disabled", "SeparatePage": "Convert to Separate Page", "PageComments": "Convert to Page Comments" } }, "JpgType": { "enum": [ "jpeg", "jpegcmyk", "jpeggray" ], "type": "string", "description": "Set JPG type.", "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" } }, "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.", "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.", "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" } }, "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" }, "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.", "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" } }, "FillOrder": { "enum": [ "0", "1" ], "type": "string", "description": "The logical order of bits within a byte.", "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" } }, "UseImagePageSize": { "type": "boolean", "description": "Use image width and height for PDF size. This property overrides PageSize, PageWidth, and PageHeight if image size is impossible to obtain when PageSize, PageWidth, and PageHeight is used.", "default": false, "x-ca-featured": false, "x-ca-label": "Use image page size", "x-ca-group": "PDF Output", "x-ca-type": "Bool", "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.", "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" } }, "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...\",\r\n \"Type\": \"image\",\r\n \"Link\": \"https://www.convertapi.com/\"\r\n },\r\n {\r\n \"Name\": \"myCustomTable\",\r\n \"Type\": \"table\",\r\n \"TableData\": [\r\n [\"Row1Cell1\", \"Row1Cell2\", \"Row1Cell3\"],\r\n [\"Row2Cell1\", \"Row2Cell2\", \"\"]\r\n ]\r\n },\r\n {\r\n \"Name\": \"myHtml\",\r\n \"Value\": \"

Hello World!

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" }, "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" }, "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" } } }