{
  "openapi": "3.0.1",
  "info": {
    "title": "ConvertAPI",
    "description": "# High-Performance File Conversion API\nConvert Word, Excel, PowerPoint, HTML, PDF and Image formats with our powerful file conversion service.\nWe support more than [200 file types.]( https://www.convertapi.com/doc/file-formats)",
    "termsOfService": "https://www.convertapi.com/terms",
    "contact": {
      "url": "https://www.convertapi.com/support",
      "email": "support@convertapi.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://v2.convertapi.com"
    },
    {
      "url": "https://eu-v2.convertapi.com"
    },
    {
      "url": "https://uk-v2.convertapi.com"
    },
    {
      "url": "https://us-v2.convertapi.com"
    },
    {
      "url": "https://ca-v2.convertapi.com"
    },
    {
      "url": "https://as-v2.convertapi.com"
    },
    {
      "url": "https://au-v2.convertapi.com"
    }
  ],
  "paths": {
    "/convert/pdf/to/tiff-fax": {
      "summary": "PDF to TIFF Fax API",
      "description": "Render PDF pages to monochrome TIFF Fax images with CCITT Group 3/4 compression. Set page range and passwords, resolution, size, and multipage.",
      "post": {
        "tags": [
          "Conversion"
        ],
        "externalDocs": {
          "description": "Read more about the converter",
          "url": "https://www.convertapi.com/pdf-to-tiff-fax"
        },
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "required": [
                  "File"
                ],
                "type": "object",
                "properties": {
                  "Timeout": {
                    "maximum": 1200,
                    "minimum": 10,
                    "type": "integer",
                    "description": "Conversion timeout in seconds.",
                    "default": 900,
                    "x-ca-featured": false,
                    "x-ca-label": "Timeout",
                    "x-ca-group": "Execution",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "10",
                      "to": "1200"
                    }
                  },
                  "StoreFile": {
                    "type": "boolean",
                    "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Store file",
                    "x-ca-group": "Output",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "File": {
                    "type": "string",
                    "description": "File to be converted. Value can be URL or file content.",
                    "format": "binary",
                    "x-ca-featured": true,
                    "x-ca-label": "File",
                    "x-ca-group": "Input",
                    "x-ca-type": "File",
                    "x-ca-representation": "Default",
                    "x-ca-allowed-extensions": [
                      "pdf"
                    ]
                  },
                  "FileName": {
                    "type": "string",
                    "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.",
                    "x-ca-featured": false,
                    "x-ca-label": "Output file name",
                    "x-ca-group": "Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "200"
                    }
                  },
                  "Password": {
                    "type": "string",
                    "description": "Sets the password to open protected documents.",
                    "x-ca-featured": false,
                    "x-ca-label": "Open Password",
                    "x-ca-group": "PDF",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "ImageResolution": {
                    "enum": [
                      "204x98",
                      "204x196"
                    ],
                    "type": "string",
                    "description": "Set output image resolution in dpi.\n * `204x98` - 204x98 dpi\n * `204x196` - 204x196 dpi",
                    "default": "204x98",
                    "x-ca-featured": false,
                    "x-ca-label": "Image Resolution",
                    "x-ca-group": "Image",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "204x98": "204x98 dpi",
                      "204x196": "204x196 dpi"
                    }
                  },
                  "ImageWidth": {
                    "enum": [
                      "1728",
                      "2048",
                      "2482"
                    ],
                    "type": "string",
                    "description": "Image width in pixels.\n * `1728` - 1728 pixels (8.5 in)\n * `2048` - 2048 pixels (10 in)\n * `2482` - 2482 pixels (12.2 in)",
                    "default": "1728",
                    "x-ca-featured": false,
                    "x-ca-label": "Image Width",
                    "x-ca-group": "Image",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "1728": "1728 pixels (8.5 in)",
                      "2048": "2048 pixels (10 in)",
                      "2482": "2482 pixels (12.2 in)"
                    }
                  },
                  "TextAntialiasing": {
                    "enum": [
                      "0",
                      "1",
                      "2",
                      "4"
                    ],
                    "type": "string",
                    "description": "Control the use of text subsample antialiasing. The subsampling box size should be 4 bits for optimum text antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits",
                    "default": "1",
                    "x-ca-featured": false,
                    "x-ca-label": "Text antialiasing",
                    "x-ca-group": "Image",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "0": "None",
                      "1": "1 bit",
                      "2": "2 bits",
                      "4": "4 bits"
                    }
                  },
                  "GraphicsAntialiasing": {
                    "enum": [
                      "0",
                      "1",
                      "2",
                      "4"
                    ],
                    "type": "string",
                    "description": "Control the use of graphics content subsample antialiasing. The subsampling box size should be 4 bits for optimum graphics content antialiasing, but smaller values can be used for faster rendering.\n * `0` - None\n * `1` - 1 bit\n * `2` - 2 bits\n * `4` - 4 bits",
                    "default": "1",
                    "x-ca-featured": false,
                    "x-ca-label": "Graphics antialiasing",
                    "x-ca-group": "Image",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "0": "None",
                      "1": "1 bit",
                      "2": "2 bits",
                      "4": "4 bits"
                    }
                  },
                  "ImageInterpolation": {
                    "type": "boolean",
                    "description": "Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Image interpolation",
                    "x-ca-group": "Image",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "DitheringMethod": {
                    "enum": [
                      "default",
                      "sierra",
                      "burkes",
                      "stucki",
                      "floyd",
                      "jarvis",
                      "cluster6",
                      "cluster8",
                      "cluster16",
                      "bayer4",
                      "bayer8"
                    ],
                    "type": "string",
                    "description": "Specifies the dithering algorithm.\n * `default` - Default\n * `sierra` - Sierra\n * `burkes` - Burkes\n * `stucki` - Stucki\n * `floyd` - Floyd\n * `jarvis` - Jarvis\n * `cluster6` - Cluster 6x6\n * `cluster8` - Cluster 8x8\n * `cluster16` - Cluster 16x16\n * `bayer4` - Bayer 4x4\n * `bayer8` - Bayer 8x8",
                    "default": "default",
                    "x-ca-featured": false,
                    "x-ca-label": "Dithering Method",
                    "x-ca-group": "Image",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "default": "Default",
                      "sierra": "Sierra",
                      "burkes": "Burkes",
                      "stucki": "Stucki",
                      "floyd": "Floyd",
                      "jarvis": "Jarvis",
                      "cluster6": "Cluster 6x6",
                      "cluster8": "Cluster 8x8",
                      "cluster16": "Cluster 16x16",
                      "bayer4": "Bayer 4x4",
                      "bayer8": "Bayer 8x8"
                    }
                  },
                  "Wts": {
                    "type": "boolean",
                    "description": "Use Well Tempered Screening algorithm for halftoning.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Well Tempered Screening",
                    "x-ca-group": "Image",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "TiffType": {
                    "enum": [
                      "monochromeg3",
                      "monochromeg32d",
                      "monochromeg4",
                      "monochromelzw",
                      "monochromepackbits"
                    ],
                    "type": "string",
                    "description": "Set TIFF FAX type.\n * `monochromeg3` - Monochrome - G3 fax encoding with EOLs\n * `monochromeg32d` - Monochrome - 2-D G3 fax encoding\n * `monochromeg4` - Monochrome - G4 fax encoding\n * `monochromelzw` - Monochrome - LZW-compatible compression\n * `monochromepackbits` - Monochrome - PackBits compression",
                    "default": "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"
                    }
                  },
                  "MultiPage": {
                    "type": "boolean",
                    "description": "Create multi-page TIFF file.",
                    "default": true,
                    "x-ca-featured": false,
                    "x-ca-label": "Multi-page",
                    "x-ca-group": "TIFF Output",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "FillOrder": {
                    "enum": [
                      "0",
                      "1"
                    ],
                    "type": "string",
                    "description": "The logical order of bits within a byte.\n * `0` - MSB-to-LSB\n * `1` - LSB-to-MSB",
                    "default": "0",
                    "x-ca-featured": false,
                    "x-ca-label": "Fill order",
                    "x-ca-group": "TIFF Output",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "0": "MSB-to-LSB",
                      "1": "LSB-to-MSB"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ConversionCost": {
                      "type": "integer",
                      "description": "This amount will be deducted from your balance after the conversion.",
                      "format": "int32",
                      "example": 1
                    },
                    "Files": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "FileName": {
                            "type": "string",
                            "description": "Name of the converted file.",
                            "example": "myfile.pdf"
                          },
                          "FileExt": {
                            "type": "string",
                            "description": "File type (file name extension)",
                            "example": "pdf"
                          },
                          "FileSize": {
                            "type": "integer",
                            "description": "File size",
                            "format": "int32",
                            "example": 111955
                          },
                          "FileId": {
                            "type": "string",
                            "description": "File ID",
                            "example": "25811safe8e61dd3f51ef00ee5f58b92"
                          },
                          "Url": {
                            "type": "string",
                            "description": "File URL",
                            "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf"
                          },
                          "FileData": {
                            "type": "string",
                            "description": "Base64 encoded file data",
                            "format": "base64",
                            "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
                          }
                        }
                      }
                    }
                  },
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#applicationjson-1"
                  }
                }
              },
              "multipart/mixed": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#multipartmixed"
                  }
                },
                "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n"
              },
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "415": {
            "$ref": "#/components/responses/415"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "security": [
          {
            "secret": [ ]
          },
          {
            "token": [ ]
          },
          {
            "jwt": [ ]
          }
        ]
      },
      "x-ca-overview": "Convert PDF documents to fax‑ready monochrome TIFF using CCITT Group 3 or Group 4 compression for compact, interoperable output. Handle password‑protected files and restrict processing to specific page ranges to create targeted exports. Control resolution (DPI) and explicit width/height to meet telephony or archive constraints, and produce single‑ or multi‑page TIFF as needed. Ideal for records workflows, legacy fax systems, and integrations requiring predictable black‑and‑white raster images with very small file sizes.",
      "x-ca-meta-title": "PDF to TIFF Fax Conversion API – Fax‑ready TIFF.",
      "x-ca-meta-description": "Convert PDF to monochrome TIFF Fax via API. Use CCITT G3/G4 compression, set page range, resolution, size, and output single or multipage TIFF.",
      "x-ca-source-formats": "pdf",
      "x-ca-destination-formats": "tiff",
      "x-ca-tags": [
        "pdf",
        "image"
      ]
    }
  },
  "components": {
    "schemas": {
      "fileId": {
        "maxLength": 32,
        "minLength": 32,
        "type": "string",
        "description": "Uploaded File ID",
        "example": "25811safe8e61dd3f51ef00ee5f58b92"
      },
      "error": {
        "type": "object",
        "properties": {
          "Code": {
            "type": "integer",
            "description": "Error message code",
            "format": "int32",
            "example": 4000
          },
          "Message": {
            "type": "string",
            "description": "Error message text",
            "example": "Parameter validation error."
          }
        },
        "externalDocs": {
          "url": "https://www.convertapi.com/doc/response-codes"
        }
      }
    },
    "responses": {
      "400": {
        "description": "Malformed request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "401": {
        "description": "Authentication error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "415": {
        "description": "File type error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "500": {
        "description": "Conversion failure",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "503": {
        "description": "Conversion rate limit error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      }
    },
    "parameters": {
      "fileId": {
        "name": "fileId",
        "in": "path",
        "description": "File ID",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/fileId"
        }
      },
      "src": {
        "name": "src",
        "in": "path",
        "description": "Source file format (docx, pdf, jpg etc.)",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "dst": {
        "name": "dst",
        "in": "path",
        "description": "Destination file format (docx, pdf, jpg etc.)",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "headers": {
      "content-disposition": {
        "description": "File information ([docummentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition))",
        "schema": {
          "type": "string"
        }
      },
      "file-name": {
        "description": "File name",
        "schema": {
          "type": "string"
        }
      },
      "file-ext": {
        "description": "File name extension",
        "schema": {
          "type": "string"
        }
      },
      "file-size": {
        "description": "File size",
        "schema": {
          "type": "integer"
        }
      }
    },
    "securitySchemes": {
      "secret": {
        "type": "http",
        "description": "[Get `Secret`](https://www.convertapi.com/a/secret)",
        "scheme": "bearer"
      },
      "token": {
        "type": "http",
        "description": "[Get `Token`](https://www.convertapi.com/a/api-tokens)",
        "scheme": "bearer"
      },
      "jwt": {
        "type": "http",
        "description": "[Get `JWT`](https://www.convertapi.com/a/jwt-tokens)",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "tags": [
    {
      "name": "Conversion",
      "description": "File Conversion API call",
      "externalDocs": {
        "description": "File Conversion related operations",
        "url": "https://www.convertapi.com/doc/content-types"
      }
    },
    {
      "name": "File Server",
      "description": "ConvertAPI temporary file storage",
      "externalDocs": {
        "description": "File Server related operations",
        "url": "https://www.convertapi.com/doc/upload"
      }
    },
    {
      "name": "User",
      "description": "API User",
      "externalDocs": {
        "description": "API User related operations",
        "url": "https://www.convertapi.com/doc/user"
      }
    }
  ],
  "externalDocs": {
    "description": "Find out more about ConvertAPI",
    "url": "https://www.convertapi.com/doc"
  }
}