{
  "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/pdf": {
      "summary": "PDF to PDF API",
      "description": "Modify PDF documents by embedding fonts, setting metadata, adjusting viewer preferences, and optimizing color spaces easily.",
      "post": {
        "tags": [
          "Conversion"
        ],
        "externalDocs": {
          "description": "Read more about the converter",
          "url": "https://www.convertapi.com/pdf-to-pdf"
        },
        "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"
                    }
                  },
                  "EmbedFonts": {
                    "type": "boolean",
                    "description": "Embed fonts in PDF.",
                    "default": true,
                    "x-ca-featured": false,
                    "x-ca-label": "Embed fonts",
                    "x-ca-group": "PDF Fonts",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "SubsetFonts": {
                    "type": "boolean",
                    "description": "Include in the output PDF document only the font characters that are used in the original document.",
                    "default": true,
                    "x-ca-featured": false,
                    "x-ca-label": "Subset fonts",
                    "x-ca-group": "PDF Fonts",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  },
                  "PdfVersion": {
                    "enum": [
                      "1.2",
                      "1.3",
                      "1.4",
                      "1.5",
                      "1.6",
                      "1.7",
                      "1.8",
                      "2.0"
                    ],
                    "type": "string",
                    "description": "Set PDF version.",
                    "default": "1.5",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF version",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "1.2": "Acrobat 3 (PDF 1.2)",
                      "1.3": "Acrobat 4 (PDF 1.3)",
                      "1.4": "Acrobat 5 (PDF 1.4)",
                      "1.5": "Acrobat 6 (PDF 1.5)",
                      "1.6": "Acrobat 7 (PDF 1.6)",
                      "1.7": "Acrobat 8 (PDF 1.7)",
                      "1.8": "Acrobat 9 (PDF 1.7, e-level 3)",
                      "2.0": "Acrobat DC (PDF 2.0)"
                    }
                  },
                  "PdfTitle": {
                    "type": "string",
                    "description": "Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF title",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "PdfSubject": {
                    "type": "string",
                    "description": "Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF subject",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "PdfAuthor": {
                    "type": "string",
                    "description": "Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF author",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "PdfCreator": {
                    "type": "string",
                    "description": "Provide a value to customize the PDF creator. Otherwise, the default document creator will be used. Use single quotes and a space (' ') to remove the creator.",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF creator",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "PdfKeywords": {
                    "type": "string",
                    "description": "Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF keywords",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default"
                  },
                  "OpenPage": {
                    "maximum": 3000,
                    "minimum": 1,
                    "type": "integer",
                    "description": "Set the page number at which the PDF document should open.",
                    "default": 1,
                    "x-ca-featured": false,
                    "x-ca-label": "Open to page",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "3000"
                    }
                  },
                  "OpenZoom": {
                    "enum": [
                      "Default",
                      "ActualSize",
                      "FitPage",
                      "FitWidth",
                      "FitHeight",
                      "FitVisible",
                      "25",
                      "50",
                      "75",
                      "100",
                      "125",
                      "150",
                      "200",
                      "400",
                      "800",
                      "1600",
                      "2400",
                      "3200",
                      "6400"
                    ],
                    "type": "string",
                    "description": "Set the default zoom percentage for when you open PDF files .",
                    "default": "Default",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF default zoom",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "Default": "Default",
                      "ActualSize": "Actual Size",
                      "FitPage": "Fit Page",
                      "FitWidth": "Fit Width",
                      "FitHeight": "Fit Height",
                      "FitVisible": "Fit Visible",
                      "25": "25%",
                      "50": "50%",
                      "75": "75%",
                      "100": "100%",
                      "125": "125%",
                      "150": "150%",
                      "200": "200%",
                      "400": "400%",
                      "800": "800%",
                      "1600": "1600%",
                      "2400": "2400%",
                      "3200": "3200%",
                      "6400": "6400%"
                    }
                  },
                  "ColorSpace": {
                    "enum": [
                      "Default",
                      "RGB",
                      "CMYK",
                      "Gray"
                    ],
                    "type": "string",
                    "description": "Set PDF color space.",
                    "default": "Default",
                    "x-ca-featured": false,
                    "x-ca-label": "PDF color space",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "Default": "Default",
                      "RGB": "RGB",
                      "CMYK": "CMYK",
                      "Gray": "Gray"
                    }
                  }
                }
              }
            }
          }
        },
        "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": "Take full control of your PDF documents with our feature-rich API. Easily `embed fonts`, `subset characters`, set the `PDF version`, and adjust key `metadata` like title, subject, author, and more. Customize default page view settings, including `page number` and `zoom`, and choose the perfect `ColorSpace` for optimal presentation. Our PDF API gives you the flexibility to fine-tune every detail of your PDFs.",
      "x-ca-meta-title": "PDF to PDF API – Advanced PDF Manipulation and Optimization",
      "x-ca-meta-description": "Enhance your PDF files with our PDF to PDF API. Easily embed fonts, subset characters, set PDF version, customize metadata, and choose your ColorSpace for superior document control.",
      "x-ca-source-formats": "pdf",
      "x-ca-destination-formats": "pdf",
      "x-ca-tags": [
        "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"
  }
}