{
  "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/txt/to/pdf": {
      "summary": "Text to PDF API",
      "description": "Convert plain text files to PDF with page parameters.",
      "post": {
        "tags": [
          "Conversion"
        ],
        "externalDocs": {
          "description": "Read more about the converter",
          "url": "https://www.convertapi.com/txt-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": [
                      "txt"
                    ]
                  },
                  "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"
                    }
                  },
                  "PageRange": {
                    "type": "string",
                    "description": "Set page range. Example 1-10.",
                    "default": "1-2000",
                    "x-ca-featured": false,
                    "x-ca-label": "Page Range",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "String",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "1",
                      "to": "6000"
                    }
                  },
                  "FontName": {
                    "enum": [
                      "Arial",
                      "Bahnschrift",
                      "Calibri",
                      "Cambria",
                      "Consolas",
                      "Constantia",
                      "CourierNew",
                      "Georgia",
                      "Tahoma",
                      "TimesNewRoman",
                      "Verdana"
                    ],
                    "type": "string",
                    "description": "Specifies the text font name. Contact us if you are looking for a specific font for a text that is missing from the list.",
                    "default": "CourierNew",
                    "x-ca-featured": false,
                    "x-ca-label": "Text font name",
                    "x-ca-group": "Text",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "Arial": "Arial",
                      "Bahnschrift": "Bahnschrift",
                      "Calibri": "Calibri",
                      "Cambria": "Cambria",
                      "Consolas": "Consolas",
                      "Constantia": "Constantia",
                      "CourierNew": "Courier New",
                      "Georgia": "Georgia",
                      "Tahoma": "Tahoma",
                      "TimesNewRoman": "Times New Roman",
                      "Verdana": "Verdana"
                    }
                  },
                  "FontSize": {
                    "maximum": 72,
                    "minimum": 4,
                    "type": "integer",
                    "description": "Specifies the text font size.",
                    "default": 12,
                    "x-ca-featured": false,
                    "x-ca-label": "Text font size",
                    "x-ca-group": "Text",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "4",
                      "to": "72"
                    }
                  },
                  "PageOrientation": {
                    "enum": [
                      "portrait",
                      "landscape"
                    ],
                    "type": "string",
                    "description": "Set page orientation.",
                    "default": "portrait",
                    "x-ca-featured": false,
                    "x-ca-label": "Page orientation",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "portrait": "Portrait",
                      "landscape": "Landscape"
                    }
                  },
                  "PageSize": {
                    "enum": [
                      "letter",
                      "lettersmall",
                      "tabloid",
                      "ledger",
                      "legal",
                      "statement",
                      "executive",
                      "a3",
                      "a4",
                      "a4small",
                      "a5",
                      "b4",
                      "b5"
                    ],
                    "type": "string",
                    "description": "Page size.",
                    "default": "a4",
                    "x-ca-featured": false,
                    "x-ca-label": "Page size",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Collection",
                    "x-ca-representation": "Dropdown",
                    "x-ca-values": {
                      "letter": "Letter",
                      "lettersmall": "Letter Small",
                      "tabloid": "Tabloid",
                      "ledger": "Ledger",
                      "legal": "Legal",
                      "statement": "Statement",
                      "executive": "Executive",
                      "a3": "A3",
                      "a4": "A4",
                      "a4small": "A4 Small",
                      "a5": "A5",
                      "b4": "B4",
                      "b5": "B5"
                    }
                  },
                  "MarginLeft": {
                    "maximum": 500,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Set the page left margin in millimeters (mm).",
                    "default": 5,
                    "x-ca-featured": false,
                    "x-ca-label": "Margin left",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "500"
                    }
                  },
                  "MarginRight": {
                    "maximum": 500,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Set the page right margin in millimeters (mm).",
                    "default": 5,
                    "x-ca-featured": false,
                    "x-ca-label": "Margin right",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "500"
                    }
                  },
                  "MarginTop": {
                    "maximum": 500,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Set the page top margin in millimeters (mm).",
                    "default": 10,
                    "x-ca-featured": false,
                    "x-ca-label": "Margin top",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "500"
                    }
                  },
                  "MarginBottom": {
                    "maximum": 500,
                    "minimum": 0,
                    "type": "integer",
                    "description": "Set the page bottom margin in millimeters (mm).",
                    "default": 10,
                    "x-ca-featured": false,
                    "x-ca-label": "Margin bottom",
                    "x-ca-group": "Page Options",
                    "x-ca-type": "Integer",
                    "x-ca-representation": "Default",
                    "x-ca-range": {
                      "from": "0",
                      "to": "500"
                    }
                  },
                  "Pdfa": {
                    "type": "boolean",
                    "description": "Create PDF/A-1b compliant document.",
                    "default": false,
                    "x-ca-featured": false,
                    "x-ca-label": "Create PDF/A",
                    "x-ca-group": "PDF Output",
                    "x-ca-type": "Bool",
                    "x-ca-representation": "Default"
                  }
                }
              }
            }
          }
        },
        "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": "Easily turn text, logs, and plain text files into PDFs or PDF/A with our TXT to PDF API. Set page size, orientation, and margins as you like, and make your PDFs smaller with our compression feature. Great for anyone needing quick and flexible text document conversion API.",
      "x-ca-meta-title": "TXT to PDF API: Convert Text, Logs to PDF/PDF-A. Customize & Compress",
      "x-ca-meta-description": "Convert text, logs to PDF/PDF-A easily. Customize page size, orientation, margins, and compress files with our flexible text to PDF conversion API.",
      "x-ca-source-formats": "txt",
      "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"
  }
}