{
  "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/html/to/png": {
      "summary": "HTML to PNG API",
      "description": "Render HTML pages to PNG images with sizing, crop, and transparency controls.",
      "post": {
        "tags": [
          "Conversion"
        ],
        "externalDocs": {
          "description": "Read more about the converter",
          "url": "https://www.convertapi.com/html-to-png"
        },
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "required": [
                  "File"
                ],
                "type": "object",
                "properties": {
                  "StoreFile": {
                    "type": "boolean",
                    "description": "When the `StoreFile` parameter is set to `True`, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.\r\n\r\nWhen `StoreFile` is set to `False`, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.\r\n",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Store file",
                    "x-ca-group": "Output",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "FileName": {
                    "type": "string",
                    "description": "The `FileName` property defines the name of the output file(s) generated by the file conversion API, ensuring safe and\r\nunique file naming. It sanitizes input filenames to remove potentially harmful characters, automatically appends the\r\ncorrect file extension based on the target format, and includes an indexing feature to distinguish multiple output files\r\nfrom a single input. For example, converting `report.docx` to PDF format might result in `report.pdf` for a single file,\r\nor `report_0.pdf`, `report_1.pdf` for multiple files, ensuring each output file is uniquely identifiable.",
                    "x-ca-featured": false,
                    "x-ca-label": "Output file name",
                    "x-ca-group": "Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "200"
                    }
                  },
                  "Timeout": {
                    "maximum": 1200,
                    "minimum": 10,
                    "type": "integer",
                    "description": "Conversion timeout in seconds.",
                    "default": 120,
                    "x-ca-featured": false,
                    "x-ca-label": "Timeout",
                    "x-ca-group": "Execution",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "10",
                      "to": "1200"
                    }
                  },
                  "ConversionDelay": {
                    "maximum": 30,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.",
                    "default": 0,
                    "x-ca-featured": false,
                    "x-ca-label": "Conversion delay",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "30"
                    }
                  },
                  "Version": {
                    "enum": [
                      "latest",
                      "130",
                      "126",
                      "117"
                    ],
                    "type": "string",
                    "description": "Specify a particular version of the Chromium engine to render the web page.",
                    "default": "117",
                    "x-ca-featured": false,
                    "x-ca-label": "Chromium Version",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "latest": "Latest (140)",
                      "130": "130",
                      "126": "126",
                      "117": "117"
                    }
                  },
                  "AuthUsername": {
                    "type": "string",
                    "description": "HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.",
                    "x-ca-featured": false,
                    "x-ca-label": "Authentication username",
                    "x-ca-group": "Request",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "AuthPassword": {
                    "type": "string",
                    "description": "HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.",
                    "x-ca-featured": false,
                    "x-ca-label": "Authentication password",
                    "x-ca-group": "Request",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "AdBlock": {
                    "type": "boolean",
                    "description": "Block ads in converting page.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Ad block",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "CookieConsentBlock": {
                    "type": "boolean",
                    "description": "Tries to remove EU regulation required cookie warnings from web pages.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Remove cookie warnings",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "Cookies": {
                    "type": "string",
                    "description": "Set additional cookies for the page request. Example: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3",
                    "x-ca-featured": false,
                    "x-ca-label": "Cookies for the page request",
                    "x-ca-group": "Request",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "JavaScript": {
                    "type": "boolean",
                    "description": "Allow web pages to run JavaScript.",
                    "default": true,
                    "x-ca-featured": false,
                    "x-ca-label": "Enable JavaScript",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "WaitElement": {
                    "type": "string",
                    "description": "Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.",
                    "x-ca-featured": false,
                    "x-ca-label": "Wait for DOM element",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "UserJs": {
                    "type": "string",
                    "description": "Execute provided JavaScript before conversion begins.",
                    "x-ca-featured": false,
                    "x-ca-label": "Execute JavaScript",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "UserCss": {
                    "type": "string",
                    "description": "Apply additional CSS before conversion begins.",
                    "x-ca-featured": false,
                    "x-ca-label": "Apply additional CSS",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "HideElements": {
                    "type": "string",
                    "description": "Element selector string of the DOM elements that needs to be hidden during conversion.",
                    "x-ca-featured": false,
                    "x-ca-label": "Hide DOM elements",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "CssMediaType": {
                    "type": "string",
                    "description": "Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.",
                    "default": "screen",
                    "x-ca-featured": false,
                    "x-ca-label": "CSS media type",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "Headers": {
                    "type": "string",
                    "description": "Set custom HTTP headers to include in the request. Format: `Header1:Value1|Header2:Value2|Header3:Value3`\r\n\r\n- Each header is separated by `|`.\r\n- Each name/value pair is separated by `:`.",
                    "x-ca-featured": false,
                    "x-ca-label": "Custom Headers",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "ImageWidth": {
                    "maximum": 20000,
                    "minimum": 10,
                    "type": "integer",
                    "description": "Image width in pixels.",
                    "x-ca-featured": false,
                    "x-ca-label": "Image width",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "10",
                      "to": "20000"
                    }
                  },
                  "ImageHeight": {
                    "maximum": 20000,
                    "minimum": 10,
                    "type": "integer",
                    "description": "Image height in pixels.",
                    "x-ca-featured": false,
                    "x-ca-label": "Image height",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "10",
                      "to": "20000"
                    }
                  },
                  "CropElement": {
                    "type": "string",
                    "description": "Element selector string of the DOM element that should be converted. Element will be cropped from the document.",
                    "x-ca-featured": false,
                    "x-ca-label": "Crop DOM element",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "CropX": {
                    "maximum": 16384,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Screenshot crop X offset.",
                    "x-ca-featured": false,
                    "x-ca-label": "Crop X offset",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "16384"
                    }
                  },
                  "CropY": {
                    "maximum": 16384,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Screenshot crop Y offset.",
                    "x-ca-featured": false,
                    "x-ca-label": "Crop Y offset",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "16384"
                    }
                  },
                  "CropWidth": {
                    "maximum": 16384,
                    "minimum": 1,
                    "type": "integer",
                    "description": "Screenshot crop width.",
                    "x-ca-featured": false,
                    "x-ca-label": "Crop width",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "16384"
                    }
                  },
                  "CropHeight": {
                    "maximum": 16384,
                    "minimum": 1,
                    "type": "integer",
                    "description": "Screenshot crop height.",
                    "x-ca-featured": false,
                    "x-ca-label": "Crop height",
                    "x-ca-group": "Image",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "16384"
                    }
                  },
                  "Zoom": {
                    "maximum": 10,
                    "minimum": 0.1,
                    "type": "number",
                    "description": "Set the default zoom level of webpages.",
                    "default": 1,
                    "x-ca-featured": false,
                    "x-ca-label": "Zoom",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Double",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0.1",
                      "to": "10"
                    }
                  },
                  "TransparentBackground": {
                    "type": "boolean",
                    "description": "Sets default background color to transparent to get transparency in the image. Also, for this property to work, the source HTML BODY background color should be set to none.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Transparent background",
                    "x-ca-group": "Web Rendering",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "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": [
                      "htm",
                      "html"
                    ]
                  }
                }
              }
            }
          }
        },
        "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 HTML/HTM files to PNG screenshots using a modern headless browser renderer. Control output width/height, zoom level, and crop by CSS selector or coordinates; optionally use a transparent background for overlays. Customize loading with timeouts, delays, and wait‑for‑element; run page JavaScript; inject custom CSS/JS; block ads and cookie banners; hide elements; and set headers, cookies, and basic auth. Great for crisp, lossless thumbnails, previews, and documentation.",
      "x-ca-meta-title": "HTML to PNG Conversion API – Website Screenshots",
      "x-ca-meta-description": "Convert HTML to PNG via API. Control size, crop, zoom, and transparency with JS/CSS injection, headers, cookies, and auth.",
      "x-ca-source-formats": "htm,html",
      "x-ca-destination-formats": "png",
      "x-ca-tags": [
        "html",
        "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"
  }
}