ConvertAPI · Schema

ConversionRequest

Common properties for ConvertAPI conversion request bodies

File ConversionPDFDocumentsImagesAudioVideoE-booksOffice DocumentsBatch Processing

Properties

Name Type Description
file string The file to upload
Timeout integer Conversion timeout in seconds.
StoreFile boolean When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to
File string File to be converted. Value can be URL or file content.
FileName string The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and unique file naming. It sanitizes input filenames to remove potentially harmful ch
ImageResolution integer Set output image resolution in dpi.
ScaleImage boolean 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.
ScaleProportions boolean If set to true, the barcode will be generated using recommended proportions based on the larger dimension.
ScaleIfLarger boolean Scaling only if the input image is larger than the output.
ImageHeight integer Image height in pixels.
ImageWidth integer Image width in pixels.
ImageInterpolation boolean 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.
ColorSpace string Set image color space.
ImageQuality integer Set output image quality.
TransparentColor string 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 25
MultiPage boolean Create multi-page TIFF file.
Password string Sets the password to open protected PDF.
PageRange string Set PDF page range to convert. Example 1-10 or 1,2,5.
BarcodeFormat string The format of the barcode to detect. Select 'Auto' to detect all supported formats.
DetectMultiple boolean If set to true, the converter will attempt to detect multiple barcodes.
EnhancedDetection boolean If set to true, the converter will use more intensive algorithms to detect barcodes.
IncludeInverted boolean If set to true, the converter will also try to detect barcodes with inverted colors.
AutoRotate boolean If set to true, the converter will automatically rotate the view to detect barcodes.
Rotate integer Rotate the image by a specified degree. For automatic rotation using EXIF data in TIFF and JPEG images, leave this property empty.
ColorProfile string Set image color profile. Some profiles will override the ColorSpace property.
MarginHorizontal integer Set the page horizontal margin in millimeters (mm).
MarginVertical integer Set the page vertical margin in millimeters (mm).
PageSize string The property scales each image to fit a given page size.
PageOrientation string Set page orientation. Works only with the PageSize property when it is set to a value other than the Image size.
Pdfa boolean Create PDF/A-1b compliant document.
Preset string 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-mad
ColorMode string Determines whether the image is traced in black-and-white or in full color.
Layering string Defines how color regions are arranged in the output SVG-either as cut-out layers or stacked overlays.
FilterSpeckle integer Removes small isolated regions during tracing.
ColorPrecision integer Sets the quantization level for color reduction.
GradientStep integer Controls how gradient transitions are divided into color steps.
CurveMode string 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` genera
CornerThreshold integer Determines sensitivity for detecting corners versus smooth curves. Effective only when `CurveMode` is set to **Spline**.
SegmentLength number Sets the average length of path segments. Effective only when `CurveMode` is set to **Spline**.
SpliceThreshold integer Defines the threshold for merging adjacent short path segments into longer ones. Effective only when `CurveMode` is set to **Spline**.
WorksheetActive boolean Set to convert active worksheet. If value is set False all worksheet will be converted.
WorksheetIndex integer Set worksheet index(number) to convert. If value is not set all worksheet will be converted.
WorksheetName string Set worksheet name to convert. If value is not set all worksheet will be converted.
ConvertMetadata boolean Convert document metadata like Title, Author, Keywords to PDF metadata.
AutoColumnFit boolean Auto fit columns to reduce unnecessary empty space in table.
AutoPageFit boolean 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 lef
ClearPrintArea boolean Clear the print area in the converting document.
Scale integer Set content scale value in percentage.
HeaderOnEachPage boolean 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 w
ThousandsSeparator string Thousands separator.
DecimalSeparator string Decimal separator.
DateFormat string Sets the date format for output document, overriding the default US locale (M/d/yyyy) to ensure consistency regardless of regional Excel settings.
Delimiter string Set fields separator.
CellType string Set Excel cell type, if set as text the date and number format will be the same as in CSV file.
Data string 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 paymen
OutputFormat string The format of the output image.
Margin integer The margin of the barcode image in pixels.
Gs1Format boolean If set to true, the barcode will be generated in GS1 format.
BaseFontSize number Base font size in points (pt). All text is scaled relative to this value.
MarginLeft number Sets the left margin in points (pt) for text on the PDF page.
MarginRight number Sets the right margin in points (pt) for text on the PDF page.
MarginTop number Sets the top margin in points (pt) for text on the PDF page.
MarginBottom number Sets the bottom margin in points (pt) for text on the PDF page.
UpdateToc boolean Update all tables of content in the document.
UpdateReferences boolean Update all reference fields in the document.
Sexual boolean Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services excluding sex education and wellness.
Harassment boolean Content that expresses, incites, or promotes harassing language towards any target. Includes harassment/threatening sub-category.
Hate boolean 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.
Illicit boolean 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-ca
SelfHarm boolean 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.
Violence boolean Content that depicts death, violence, or physical injury. Includes violence/graphic sub-category.
CompareFile string Specifies the Word document with which the specified document is compared.
CompareLevel string 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 identif
CompareFormatting boolean Determines whether to indicate variations in formatting between the two documents.
CompareCaseChanges boolean Determines whether to highlight discrepancies in capitalization between the two documents.
CompareWhitespace boolean Determines whether to identify dissimilarities in whitespace, such as gaps or paragraphs, between the two documents.
CompareTables boolean Determines whether to evaluate variations in the information presented within tables between the two documents.
CompareHeaders boolean Determines whether to contrast divergences in headers and footers between the two documents.
CompareFootnotes boolean Determines whether to compare differences in footnotes and endnotes between the two documents.
CompareTextboxes boolean Determines whether to assess differences in the information presented within text boxes between the two documents.
CompareFields boolean Determines whether to detect disparities in fields between the two documents.
CompareComments boolean Determines whether to evaluate distinctions in comments between the two documents.
CompareMoves boolean Indicates the name of the individual to credit for modifications when comparing the two documents.
AcceptRevisions boolean Specifies whether to accept revisions before document comparison.
RevisionAuthor string Author name who made revision.
InlineImages boolean Inline images to html.
ConvertMarkups boolean Convert document markups like revisions and comments.
ConvertTags boolean Convert document structure tags for accessibility.
BookmarkMode string 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
EncryptPassword string Sets a password to encrypt the Word document. This password is required to open and view the content.
Substitutions boolean Replace similar symbols with their counterparts in a text file, such as a copyright symbol with (c).
LineBreaks boolean Inserts line breaks at the end of each line of text.
EndLineChar string Set end of line character. The character which will be used to break lines.
SaveFormat string Specifies the format to use when saving a document.
XmlType string Specifies the type of XML to use when saving a Word document.
SpaceToConvert string Set space type to convert.
CustomSpaceToConvert string Set custom layout name to convert by setting it name or index. This property overrides the SpaceToConvert property.
ExportLayers boolean Export AutoCAD layers.
AutoFit boolean 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.
PageHeight integer Custom page height in millimeters (mm). This option override PageSize option.
PageWidth integer Custom page width in millimeters (mm). This option override PageSize option.
BackgroundColor string 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
ImageAntialiasing integer 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.
UseCIDAsFileName boolean Use the CID as the filename instead of the original when extracting email attachments.
IgnoreInlineAttachments boolean 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.
ConvertHeader boolean This property controls the inclusion of email header in the PDF conversion process. When set to `true`, the converter will incorporate the email's header information, such as **From**, **To**, **Subje
ConvertAttachments boolean Convert email attachments.
IgnoreAttachmentErrors boolean When enabled, attachment conversion errors are ignored and the email is still converted. This parameter is only used when `ConvertAttachments` is enabled.
Merge boolean Merge email body with attachments during the conversion process. Only works when `ConvertAttachments` property enabled.
ImageResolutionH integer Set output image horizontal resolution in dpi.
ImageResolutionV integer Set output image vertical resolution in dpi.
PdfVersion string Set PDF version.
PdfResolution integer Set PDF resolution.
PdfTitle string 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.
PdfSubject string 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.
PdfAuthor string 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.
PdfKeywords string 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.
OpenPage integer Set the page number at which the PDF document should open.
EmbedFonts boolean Embed fonts in PDF.
SubsetFonts boolean Include in the output PDF document only the font characters that are used in the original document.
SubsetFontsThreshold integer 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.
OpenZoom string Set the default zoom percentage for when you open PDF files .
Files array 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]...
CompressionLevel string Set compression level.
PersistAnimation boolean Read animation values AnimationIterations and AnimationDelay from GIF file. Only works if GIF file is added to file list.
AnimationDelay integer Delay time, in 1/100 of a second, before displaying the next frame in an animated sequence. Default is 100 (1 second).
AnimationIterations integer Set the number of iterations to loop an animation. Zero is infinity.
AlphaColor string Set a color on the alpha (transparent) channel. Values accepted are RGBA, CMYK hex string, or a color name.
ConversionDelay integer Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.
Version string Specify a particular version of the Chromium engine to render the web page.
AuthUsername string HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.
AuthPassword string HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.
AdBlock boolean Block ads in converting page.
CookieConsentBlock boolean Tries to remove EU regulation required cookie warnings from web pages.
Cookies string Set additional cookies for the page request. Example: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3
JavaScript boolean Allow web pages to run JavaScript.
WaitElement string Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.
UserJs string Execute provided JavaScript before conversion begins.
UserCss string Apply additional CSS before conversion begins.
HideElements string Element selector string of the DOM elements that needs to be hidden during conversion.
CssMediaType string 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.
Headers string Set custom HTTP headers to include in the request. Format: `Header1:Value1|Header2:Value2|Header3:Value3` - Each header is separated by `|`. - Each name/value pair is separated by `:`.
CropElement string Element selector string of the DOM element that should be converted. Element will be cropped from the document.
CropX integer Screenshot crop X offset.
CropY integer Screenshot crop Y offset.
CropWidth integer Screenshot crop width.
CropHeight integer Screenshot crop height.
Zoom number Set the default zoom level of webpages.
GithubFlavored boolean Create GitHub-flavored markdown GFM.
RemoveComments boolean Remove comment tags.
UnsupportedTags string Sets the rules on how to handle unsupported HTML tags.
PassThroughTags string 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.
ListBulletChar string Set bullet list character.
LoadLazyContent boolean Load page images that loads only when they are visible.
ViewportWidth integer Sets browser viewport width.
ViewportHeight integer Sets browser viewport height.
RespectViewport boolean 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.
Background boolean Convert web page background.
FixedElements string Change fixed elements CSS 'position' property to adapt page for conversion.
Header string 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 individua
Footer string 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 individua
ShowElements string Element selector string of the DOM elements that should be visible during conversion. Other elements will be hidden.
AvoidBreakElements string CSS selector for the elements that pages should not break.
BreakBeforeElements string CSS selector for the elements that should apply page break before it.
BreakAfterElements string CSS selector for the elements that should apply page break after it.
TransparentBackground boolean 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.
ExtractElements string Specifies a CSS selector to identify and extract specific DOM elements from the page, instead of scraping the entire content, allowing for more targeted and efficient data retrieval; for example, to s
JoinDirection string 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, allow
ImageSpacing integer The property defines the amount of space, in pixels, between individual images when they are combined into a single image.
SpacingColor string The property defines the color of the space between individual images when they are combined into a single image. This property works in conjunction with `ImageSpacing` to enhance the visual appearanc
ImageOutputFormat string 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 compatibili
CompressionPercentage integer Set compression level in percentage. Overrides `CompressionLevel` property unless it is set to `losseless`.
CompressionFileSize integer Compress a file to the file size set in kilobytes. Overrides `CompressionLevel` property unless it is set to `losseless`.
EnableOcr boolean Enable optical character recognition(OCR).
OcrLanguage string Configure the OCR language for text recognition. If auto-detection fails, manually specify the language.
Preprocessing boolean 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.
PdfaVersion string Set PDF/A version.
UnembedBaseFonts boolean Specifies whether to remove the base fonts from the PDF file.
SubsetEmbeddedFonts boolean 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.
RemoveForms boolean Remove PDF forms from the PDF file.
RemoveDuplicates boolean Remove duplicate fonts and color profiles from the PDF file.
Optimize boolean Optimize page content streams in the PDF file.
RemovePieceInformation boolean Remove piece information dictionaries like Adobe Illustrator or Photoshop private data.
RemoveEmbeddedFiles boolean Remove embedded/attachments files from the PDF file.
RemoveStructureInformation boolean Remove all structure information from the PDF document.
RemoveMetadata boolean Detach the XMP metadata embedded in the document from its catalog, clear all properties in all schemas, and remove metadata from marked content.
RemoveUnusedResources boolean Remove references to resources such as fonts, images, patterns.
Linearize boolean Linearize PDF file and optimize for fast Web View.
PreservePdfa boolean Preserve the PDF/A standard in the PDF file.
CropMode string Defines how pages are cropped: automatic content detection, cropping by margins, or cropping to an exact size using width/height or paper size.
MeasurementUnit string Specifies measurement unit to use for the page height and page width properties.
AutoStrategy string Defines whether automatic cropping is applied per page or uniformly across all pages. Takes effect when `CropMode` is set to `Auto`.
AutoPadding number Padding to add around detected content, using the selected measurement unit. Takes effect when `CropMode` is set to `Auto`.
Anchor string Anchor position to place the crop rectangle when crop height and crop width are defined.
VerticalMargin number Top and bottom margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.
HorizontalMargin number Left and right margins to apply when defining the crop box, using the selected measurement unit. Takes effect when `CropMode` is set to `Margins`.
DeleteBlankPages boolean Automatically detect and delete blank pages.
Wysiwyg boolean Persist exact formatting using text boxes.
OcrMode string Defines how OCR is applied during conversion. `Auto` performs OCR only when needed. `Force` applies OCR to all pages. `Never` disables OCR entirely.
OcrEngine string 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 langu
Annotations string 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
DocumentType string 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 docum
CustomExtractionData string A JSON array defining specific values to extract. #### Example JSON ```json [ { "FieldName": "TotalResult", "Extract": "total price" }, { "FieldName": "ServiceName", "Extract": "most expensive service
MinimumConfidence number Sets the minimum confidence threshold for AI-based detection of sensitive data. Higher values reduce false positives but may miss subtle matches.
IncludeAnnotationAttachments boolean Include attachments embedded as page-level file attachment annotations
MinimumImageWidth integer Set minimum image width in pixels. Images narrower than this value are ignored.
MinimumImageHeight integer Set minimum image height in pixels. Images shorter than this value are ignored.
IncludeAlternateNames boolean Include alternate field names (/TU) from the PDF as tooltips in the FDF output.
FdfFile string Specifies the FDF file that contains structured form data. Value can be URL or file content.
FlattenControls boolean 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.
FlattenWidgets boolean 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.
FlattenText boolean 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.
ImageFile string Specifies the image file to use as watermark. Value can be URL or file content.
Opacity integer Specifies watermark opacity level.
Style string Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.
GoToLink string Specifies the web address to go when the watermark is clicked.
GoToPage string Specifies the page number to go when the watermark is clicked.
PageRotation boolean 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.
PageBox string Specifies the PDF page box used as the reference area for applying the watermark.
HorizontalAlignment string Specifies the horizontal watermark alignment.
VerticalAlignment string Specifies the vertical watermark alignment.
OffsetX number 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`.
OffsetY number Specifies the watermark offset along the Y-axis. Positive values move the watermark downward, while negative values move it upward, using the selected `MeasurementUnit`.
CropTo string Defines the options for cropping the page.
FitToSize boolean 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.
BitDepth string Set the number of bits per color channel in the output image. Higher values improve color precision and gradient smoothness but increase file size.
RemoveDuplicateFonts boolean Do not include the same fonts from source PDFs while merging.
BookmarksToc string Adds a top-level bookmark for each file, using the filename or PDF title from metadata.
OutputType string 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 O
PageSegmentationMode string 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
Resolution integer 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.
PdfCreator string 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.
OverlayFile string Specifies the PDF file to use as overlay. Value can be URL or file content.
OverlayPage integer Specifies the page to use as overlay from the OverlayFile file.
InvoiceFormat string 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.
InvoiceFile string Specifies the structured invoice XML (ZUGFeRD / Factur-X) to embed for hybrid-invoice compatibility. Required when `InvoiceFormat` is enabled.
TextRecoveryMode string 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
TrimSize string Page size to enforce on every page. `Default` keeps each page’s current size; `Custom` activates `TrimWidth` / `TrimHeight`.
TrimWidth integer Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.
TrimHeight integer Width of Trim Box in millimeters (mm) when `TrimSize` is set to `Custom`.
BleedTop integer 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.
BleedRight integer 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.
BleedBottom integer 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 printin
BleedLeft integer 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.
BleedMode string 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 ed
TrimMarks boolean Adds crop marks outside the Bleed Box.
RegistrationMarks boolean Adds registration targets centred ≥3mm outside Bleed Box on each edge.
Slug string Text placed on the bottom of the Media Box (e.g., printed file name, order number, customer information, etc.).
TintBars boolean Adds grayscale and color control bars at the top of the page, positioned outside the Trim Box.
OutputIntent string Embeds ICC profile as PDF OutputIntent. Choosing `Custom` requires `OutputIntentIccFile` to be provided.
OutputIntentIccFile string Embeds ICC profile as PDF OutputIntent. Required when `OutputIntent` is set to `custom`.
DownsampleImages boolean Reduces images above resolution to save file size.
EncryptionAlgorithm string Sets the encryption algorithm.
EncryptMeta boolean Encrypt metadata of PDF file.
UserPassword string 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.
OwnerPassword string Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don’t need a password to open the doc
RespectOwnerPassword boolean 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 requi
PreservePermissions boolean 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.
AllowEverything boolean Enable or disable all permissions. The specific permissions listed below overrides this property.
AssembleDocument boolean Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.
CopyContents boolean Enable or disable copy or extract text and graphics from the document.
ModifyContents boolean Enable or disable changing the contents of the document.
ExtractContents boolean Enable or disable extract text and graphics.
ModifyAnnotations boolean Enable or disable adding or modifying text annotations and fill in interactive form fields.
FillFormFields boolean Enable or disable fill-in existing interactive form fields, including signature fields.
PrintDocument boolean Enable or disable document printing.
PrintFaithfulCopy boolean Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.
ContextSize string Defines how the AI engine processes the document in terms of context. When the `ContextSize` parameter is set to `Page`, each page is processed independently, without context from other pages. This mo
RedactionColor string 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 w
RedactionThickness number The RedactionThickness property controls the height of the redaction stroke line relative to the original line height. - A value of 1 means the stroke height matches the original line height. - Values
PII boolean **Personally Identifiable Information (PII)** - Detects and redacts common personal identifiers, including names, email addresses, phone numbers, birthdates, and home addresses.
PHI boolean **Patient Health Information (PHI)** - Detects health-related information such as patient names, medical records, insurance details, and prescription data.
Financial boolean **Financial Data** - Focuses on financial records, including credit card numbers, bank account numbers, financial transaction details, etc.
Legal boolean **Legal and Contractual Data** - Detects legal and contractual terms, including case numbers, legal clauses, signatures, and confidential agreements.
Confidential boolean **Legal and Contractual Data** - Detects proprietary business information, contracts and agreements, internal communications, trade secrets, intellectual property details, and sensitive corporate data
RedactionData string A JSON array defining specific values for redaction. Supports three methods: - **Text** – Exact text to be redacted. - **Regex** – *Escaped* regular expression patterns for flexible text matching. - *
FixFontEncoding boolean 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 Unico
Angle string Rotates page(s) by selected degree.
SplitByPattern string 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
SplitByRange string 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 rec
SplitByTextPattern string 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
SplitByBookmark boolean 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 ou
ExtractPages string 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.
MergeOutput boolean 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 s
Text string Specifies the text to use as watermark. The list of supported variables: * ```%PAGE%``` - current page number * ```%PAGES%``` - total number of pages * ```%FILENAME%``` - name of the file * ```%WEEKDA
FontSize integer Specifies the watermark font size.
TextRenderingMode string Specifies the text rendering mode.
FontColor string Specifies the watermark font color.
StrokeColor string Specifies font stroke color.
StrokeWidth integer Specifies the stroke width.
FontName string Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list.
Width number Specifies the width of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the width is unspecified.
Height number Specifies the height of the watermark text box in the selected `MeasurementUnit`. A value of `0` means the height is unspecified.
LineSpacing integer Specifies the watermark text line spacing.
FontEmbed boolean Specifies whether fonts should be embedded.
FontSubset boolean Specifies whether fonts should be subset.
TiffType string Set TIFF FAX type.
IncludeFormatting boolean Persist formatting while extracting text. Only works when RemoveHeadersFooters and RemoveFootnotes properties are disabled.
SplitPages boolean Split each page to different result file.
RemoveHeadersFooters boolean Remove headers and footers from the document.
RemoveFootnotes boolean Remove footnotes from the document.
RemoveTables boolean Remove tables from the document.
SingleSheet boolean Combine extracted tables into a single sheet.
ExpectedConformance string Set target PDF/A conformance. Validate against a specific version, or use `auto` to detect the document’s claimed level.
PeppolTemplateFile string 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 `{{placeh
ShowContactDetails boolean When enabled, supplier and customer contact details (name, phone, email) are included in the rendered invoice; when disabled, the contact block is hidden. Takes effect by default when the bundled temp
ShowNote boolean When enabled, the invoice note is included in the rendered invoice; when disabled, the note block is hidden. Takes effect by default when the bundled template is used. When a custom `PeppolTemplateFil
OverwriteTranslations boolean 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.
TranslationContext string 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 transl
SourceLanguage string Defines the source language for translation engine. Set concrete language or use `auto`, to let the engine detect the source language automatically.
TargetLanguage string 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.
ConvertHiddenSlides boolean Include hidden slides while converting.
ConvertSpeakerNotes string Choose how speaker notes will be converted.
JpgType string Set JPG type.
TextAntialiasing string 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.
GraphicsAntialiasing string 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.
UseCIEColor boolean Specifies whether the image parser should remap the device-dependent.
RotatePage string 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
FillOrder string The logical order of bits within a byte.
UseImagePageSize boolean 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.
BindingMethod string Choose the binding method. Select whether the converter should fill data from Word document properties fields or search for placeholders within the text.
JsonPayload string **Property Fields example:** JSON object containing values to be inserted into the **document's custom properties fields**. ```json [ { "Name": "ProductName", "Value": "Acme Product", "Type": "string"
AlphaChannel boolean Enable or disable the alpha channel if available.
Url string URI of a web page to convert. If URI has special characters like ? or & they must be encoded.
View JSON Schema on GitHub

JSON Schema

conversion-request.json Raw ↑ 
{
  "$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": [
        "Wo

# --- truncated at 32 KB (163 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/convertapi/refs/heads/main/json-schema/conversion-request.json