ConvertAPI Integration

Field	Description	Required	Format
ConvertAPI Secret	Your ConvertAPI Secret key for authentication	Yes	`xxxxxxxxxxxxxxxxxxxxxxxx`

convert_file — Convert a file from a URL to another format. Supports hundreds of conversions including PDF, DOCX, JPG, PNG, XLSX, and more.

Parameters

string

required

URL of the file to convert

string

required

Input file format (e.g. ‘docx’, ‘pdf’, ‘png’)

string

required

Output file format (e.g. ‘pdf’, ‘jpg’, ‘docx’)

string

Output filename without extension

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"
}

convert_base64_file — Convert a base64-encoded file to another format. Useful when file content is already in memory.

Parameters

string

required

Base64-encoded file content

string

required

Input file format (e.g. ‘docx’, ‘pdf’)

string

required

Output file format (e.g. ‘pdf’, ‘jpg’)

string

Output filename without extension (Default: converted)

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"
}

convert_web_url — Convert a web page URL to PDF or JPG. Renders the page and captures it as a document or image.

Parameters

string

required

Website URL to convert

string

Output format: ‘pdf’ or ‘jpg’ (Default: pdf)

string

Output filename without extension

integer

Conversion timeout in seconds (Default: 300)

integer

Delay in seconds to let page fully load before conversion

string

PDF page orientation (‘portrait’ or ‘landscape’)

string

PDF page size (e.g. ‘a4’, ‘letter’, ‘legal’)

boolean

Allow web pages to run JavaScript (Default: true)

boolean

Block ads in the converting page (Default: false)

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"
}

get_supported_formats — Get the list of supported output formats for a given input format. Use this to discover available conversions.

Parameters

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"
}

Using

Providers

Building

Tools

ConvertAPI Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Google Docs

Cal.com

Canva

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Google Docs

Cal.com

Canva

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links