{
  "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/protect": {
      "summary": "Protect PDF API",
      "description": "Secure PDF documents with 256-bit AES encryption, set owner and user passwords, and restrict printing or editing permissions.",
      "post": {
        "tags": [
          "Conversion"
        ],
        "externalDocs": {
          "description": "Read more about the converter",
          "url": "https://www.convertapi.com/pdf-to-protect"
        },
        "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": "Document",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "EncryptionAlgorithm": {
                    "enum": [
                      "Standard40Bit",
                      "Standard128Bit",
                      "Aes128Bit",
                      "Aes256Bit"
                    ],
                    "type": "string",
                    "description": "Sets the encryption algorithm.\n * `Standard40Bit` - 40-bit RC4 algorithm. Acrobat 3 (PDF 1.1) and above\n * `Standard128Bit` - 128-bit RC4 algorithm. Acrobat 5 (PDF 1.4) and above\n * `Aes128Bit` - 128-bit AES algorithm. Acrobat 7 (PDF 1.6) and above\n * `Aes256Bit` - 256-bit AES algorithm. PDF 2.0",
                    "default": "Aes256Bit",
                    "x-ca-featured": false,
                    "x-ca-label": "Encryption algorithm",
                    "x-ca-group": "Encryption",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "Standard40Bit": "40-bit RC4 algorithm. Acrobat 3 (PDF 1.1) and above",
                      "Standard128Bit": "128-bit RC4 algorithm. Acrobat 5 (PDF 1.4) and above",
                      "Aes128Bit": "128-bit AES algorithm. Acrobat 7 (PDF 1.6) and above",
                      "Aes256Bit": "256-bit AES algorithm. PDF 2.0"
                    }
                  },
                  "EncryptMeta": {
                    "type": "boolean",
                    "description": "Encrypt metadata of PDF file.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Encrypt Meta",
                    "x-ca-group": "Encryption",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "UserPassword": {
                    "type": "string",
                    "description": "Sets the user password (also known as a document open password) in the output PDF document. Users will be asked to enter this password before Acrobat Reader allows them to view the PDF document.",
                    "x-ca-featured": true,
                    "x-ca-label": "User Password",
                    "x-ca-group": "Encryption",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "OwnerPassword": {
                    "type": "string",
                    "description": "Sets owner password (also known as a permissions password). Using a owner password, you can restrict printing, editing, and copying content in the PDF. Recipients don’t need a password to open the document. They do need a password to change the restrictions the owner set.",
                    "x-ca-featured": true,
                    "x-ca-label": "Owner Password",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "RespectOwnerPassword": {
                    "type": "boolean",
                    "description": "Enable the property if you want to respect the document's owner password and permissions. If disabled - the old owner's password and permissions will be removed by default. Setting this property requires you to enter the correct owner's password into the Password property for protected documents.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Respect owner password",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "PreservePermissions": {
                    "type": "boolean",
                    "description": "Enable the property if you want to keep the document permissions unchanged. It requires you to specify the OwnerPassword. If enabled, the document permission properties will be ignored.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Preserve document permissions",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "AllowEverything": {
                    "type": "boolean",
                    "description": "Enable or disable all permissions. The specific permissions listed below overrides this property.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Allow everything",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "AssembleDocument": {
                    "type": "boolean",
                    "description": "Enable or disable assembly of the document - insert, rotate, or delete pages and create bookmarks or thumbnail images.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Assemble document",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "CopyContents": {
                    "type": "boolean",
                    "description": "Enable or disable copy or extract text and graphics from the document.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Copy contents",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "ModifyContents": {
                    "type": "boolean",
                    "description": "Enable or disable changing the contents of the document.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Modify contents",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "ExtractContents": {
                    "type": "boolean",
                    "description": "Enable or disable extract text and graphics.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Extract contents",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "ModifyAnnotations": {
                    "type": "boolean",
                    "description": "Enable or disable adding or modifying text annotations and fill in interactive form fields.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Modify annotations",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "FillFormFields": {
                    "type": "boolean",
                    "description": "Enable or disable fill-in existing interactive form fields, including signature fields.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Fill form fields",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "PrintDocument": {
                    "type": "boolean",
                    "description": "Enable or disable document printing.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Print document",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "PrintFaithfulCopy": {
                    "type": "boolean",
                    "description": "Enable or disable printing of the document to a representation from which a faithful digital copy of the PDF content could be generated.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Print faithful copy",
                    "x-ca-group": "Document Permissions",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ConversionCost": {
                      "type": "integer",
                      "description": "This amount will be deducted from your balance after the conversion.",
                      "format": "int32",
                      "example": 1
                    },
                    "Files": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "FileName": {
                            "type": "string",
                            "description": "Name of the converted file.",
                            "example": "myfile.pdf"
                          },
                          "FileExt": {
                            "type": "string",
                            "description": "File type (file name extension)",
                            "example": "pdf"
                          },
                          "FileSize": {
                            "type": "integer",
                            "description": "File size",
                            "format": "int32",
                            "example": 111955
                          },
                          "FileId": {
                            "type": "string",
                            "description": "File ID",
                            "example": "25811safe8e61dd3f51ef00ee5f58b92"
                          },
                          "Url": {
                            "type": "string",
                            "description": "File URL",
                            "example": "https://v2.convertapi.com/d/v01plsb72o0cmdooq90w4d1lnqsf6oy4/myfile.pdf"
                          },
                          "FileData": {
                            "type": "string",
                            "description": "Base64 encoded file data",
                            "format": "base64",
                            "example": "JVBERi0xLjcKJb662+4KMSAwIG9iago8PC9UeXBlIC9DYXRhbG9n..."
                          }
                        }
                      }
                    }
                  },
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#applicationjson-1"
                  }
                }
              },
              "multipart/mixed": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#multipartmixed"
                  }
                },
                "example": "--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f\nConversionCost: 1\nContent-Type: application/octet-stream\nContent-Disposition: attachment; filename=\"my_file.pdf\"; size=8475\n\n--FILE CONTENT--\n--43cf1475-ab15-4c6b-b5ee-e2cbcedfe92f--\n"
              },
              "application/octet-stream": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "externalDocs": {
                    "url": "https://www.convertapi.com/doc/content-types#applicationoctet-stream-1"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "415": {
            "$ref": "#/components/responses/415"
          },
          "500": {
            "$ref": "#/components/responses/500"
          },
          "503": {
            "$ref": "#/components/responses/503"
          }
        },
        "security": [
          {
            "secret": [ ]
          },
          {
            "token": [ ]
          },
          {
            "jwt": [ ]
          }
        ]
      },
      "x-ca-overview": "Protect PDF files with strong encryption and granular permissions. Choose AES‑256 to secure content, set user and owner passwords, and decide what recipients can do: print, copy, modify contents or annotations, fill forms, assemble, or allow everything. Preserve metadata or encrypt it as needed, and respect existing owner passwords when appropriate. Ideal for automated workflows that harden documents for sharing, compliance, and long‑term storage while keeping layout and fidelity intact.",
      "x-ca-meta-title": "Protect PDF API – Encrypt and set permissions for PDFs.",
      "x-ca-meta-description": "Encrypt PDFs with AES‑256 via API. Set user/owner passwords and fine‑grained permissions for printing, editing, copying, forms, and more.",
      "x-ca-source-formats": "pdf",
      "x-ca-destination-formats": "pdf",
      "x-ca-tags": [
        "security",
        "pdf"
      ]
    }
  },
  "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"
  }
}