Skip to main content
ConvertAPI logo

​
Overview

Add ConvertAPI to any ModuleX agent or workflow. File-format conversion (PDF, DOCX, JPG, etc.), base64 file conversion, web-page-to-PDF rendering, and format-discovery against the ConvertAPI v2 REST endpoints (v2.convertapi.com).
Categories: Productivity & Collaboration · Utilities · Convert · Documents · Auth: API Key · Actions: 4

​
Authentication

​
API Key Authentication

Authenticate using your ConvertAPI Secret key

​
Required Credentials

FieldDescriptionRequiredFormat
ConvertAPI SecretYour ConvertAPI Secret key for authenticationYesxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
file_url
string
required
URL of the file to convert
​
format_from
string
required
Input file format (e.g. ‘docx’, ‘pdf’, ‘png’)
​
format_to
string
required
Output file format (e.g. ‘pdf’, ‘jpg’, ‘docx’)
​
filename
string
Output filename without extension
​
timeout
integer
Conversion timeout in seconds (Default: 300)

​
Response

{
  "$defs": {
    "ConvertedFile": {
      "additionalProperties": false,
      "properties": {
        "filename": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filename"
        },
        "file_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Size"
        },
        "file_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Url"
        },
        "file_data_base64": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Data Base64"
        }
      },
      "title": "ConvertedFile",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "conversion_cost": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Conversion Cost"
    },
    "files": {
      "items": {
        "$ref": "#/$defs/ConvertedFile"
      },
      "title": "Files",
      "type": "array"
    },
    "format_from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format From"
    },
    "format_to": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format To"
    }
  },
  "required": [
    "success"
  ],
  "title": "ConvertFileOutput",
  "type": "object"
}

​
Parameters

​
base64_string
string
required
Base64-encoded file content
​
format_from
string
required
Input file format (e.g. ‘docx’, ‘pdf’)
​
format_to
string
required
Output file format (e.g. ‘pdf’, ‘jpg’)
​
filename
string
Output filename without extension (Default: converted)
​
timeout
integer
Conversion timeout in seconds (Default: 300)

​
Response

{
  "$defs": {
    "ConvertedFile": {
      "additionalProperties": false,
      "properties": {
        "filename": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filename"
        },
        "file_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Size"
        },
        "file_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Url"
        },
        "file_data_base64": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Data Base64"
        }
      },
      "title": "ConvertedFile",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "conversion_cost": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Conversion Cost"
    },
    "files": {
      "items": {
        "$ref": "#/$defs/ConvertedFile"
      },
      "title": "Files",
      "type": "array"
    },
    "format_from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format From"
    },
    "format_to": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format To"
    }
  },
  "required": [
    "success"
  ],
  "title": "ConvertBase64FileOutput",
  "type": "object"
}

​
Parameters

​
url
string
required
Website URL to convert
​
format_to
string
Output format: ‘pdf’ or ‘jpg’ (Default: pdf)
​
filename
string
Output filename without extension
​
timeout
integer
Conversion timeout in seconds (Default: 300)
​
conversion_delay
integer
Delay in seconds to let page fully load before conversion
​
page_orientation
string
PDF page orientation (‘portrait’ or ‘landscape’)
​
page_size
string
PDF page size (e.g. ‘a4’, ‘letter’, ‘legal’)
​
javascript
boolean
Allow web pages to run JavaScript (Default: true)
​
ad_block
boolean
Block ads in the converting page (Default: false)
​
cookie_consent_block
boolean
Try to remove cookie consent popups (Default: false)

​
Response

{
  "$defs": {
    "ConvertedFile": {
      "additionalProperties": false,
      "properties": {
        "filename": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Filename"
        },
        "file_size": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Size"
        },
        "file_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Url"
        },
        "file_data_base64": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "File Data Base64"
        }
      },
      "title": "ConvertedFile",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "conversion_cost": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Conversion Cost"
    },
    "files": {
      "items": {
        "$ref": "#/$defs/ConvertedFile"
      },
      "title": "Files",
      "type": "array"
    },
    "source_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source Url"
    },
    "format_to": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format To"
    }
  },
  "required": [
    "success"
  ],
  "title": "ConvertWebUrlOutput",
  "type": "object"
}

​
Parameters

​
format_from
string
required
Input format to check (e.g. ‘docx’, ‘pdf’, ‘png’)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "format_from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Format From"
    },
    "supported_formats": {
      "items": {
        "type": "string"
      },
      "title": "Supported Formats",
      "type": "array"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSupportedFormatsOutput",
  "type": "object"
}

​
Limits & Quotas

  • Conversions cost credits; get_supported_formats is free.
  • Long-running conversions accept a per-call timeout (default 300s).
  • Failures (non-200, empty Files, exceptions) surface as success=False with error.

Google Docs

Cal.com

Canva