Skip to main content
Convertapi logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: CONVERTAPI
  • Version: 20261101_00

Tools

Slug: CONVERTAPI_ASYNC_CONVERTTool to perform an asynchronous file conversion. Use when converting large or long-running files to avoid client timeouts.

Input Parameters

string
required
URL of the file to be converted.
string
Optional self-generated 32-character lowercase alphanumeric job identifier.
string
Optional callback URL to receive a POST when conversion completes.
string
required
Source file format (path parameter), e.g., ‘docx’.
string
required
Destination file format (path parameter), e.g., ‘pdf’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_ASYNC_DELETE_JOBTool to delete a previously created asynchronous conversion job. Use when the job is no longer required to free server resources.

Input Parameters

string
required
32-character lowercase alphanumeric JobId returned by an async conversion request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CHECK_CONVERSION_SUPPORTTool to check whether a specific file format conversion is supported by ConvertAPI. Use this before attempting conversions to verify compatibility and avoid errors.

Input Parameters

string
required
Source file format to check (e.g., ‘pdf’, ‘docx’, ‘jpg’). Use lowercase format extensions.
string
required
Destination file format to check (e.g., ‘docx’, ‘pdf’, ‘png’). Use lowercase format extensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CONVERT_DELETE_UPLOADED_FILETool to delete a previously uploaded file. Use when the file is no longer needed and should be removed from temporary storage.

Input Parameters

string
required
ID of the uploaded file to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUTRetrieves a complete list of input file formats that ConvertAPI can convert to a specified output format. Use this to check which source formats are compatible with your desired target format before initiating conversions.

Input Parameters

string
required
Target output file format to check compatibility for. Common formats include: ‘pdf’, ‘docx’, ‘jpg’, ‘png’, ‘html’, ‘txt’, ‘xlsx’. Use lowercase format extensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CONVERT_PDF_TO_DOCXConverts PDF content or a URL to DOCX and returns file metadata, with inline file data or download URLs depending on storage options. A filename is required for raw file content.

Input Parameters

string
required
PDF file to convert. Provide raw binary or a publicly accessible URL.
string ("auto" | "force" | "never")
OCR behavior: ‘auto’, ‘force’, or ‘never’.
integer
Conversion timeout in seconds.
boolean
Persist exact formatting using text boxes.
string
Desired output DOCX file name. Required when sending raw file content.
string
Password to open protected PDF documents.
string ("native" | "tesseract")
OCR engine to use: ‘native’ or ‘tesseract’.
string
Page range to convert, e.g., ‘1-10’ or ‘1,3,5’.
boolean
Store converted file on server and return a download URL.
string ("textBox" | "comment" | "none")
How to handle PDF annotations: ‘textBox’ (editable text box), ‘comment’ (Word comments), or ‘none’ (omit annotations).
string ("auto" | "ar" | "ca" | "zh" | "da" | "nl" | "en" | "fi" | "fr" | "de" | "el" | "ko" | "it" | "ja" | "no" | "pl" | "pt" | "ro" | "ru" | "sl" | "es" | "sv" | "tr" | "ua" | "th")
OCR language code or ‘auto’ for automatic detection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CONVERT_PDF_TO_JPG_AND_STORETool to convert a PDF to JPG and store the result on the server. Use when individual JPG pages are needed for further workflow steps.

Input Parameters

string
required
PDF source: raw file bytes, a publicly accessible URL, or a ConvertAPI file URL (e.g., ‘https://v2.convertapi.com/d/FILE_ID’).
string
Custom name for the output JPG file(s). Required when File is raw bytes. Optional when File is a URL to override the default name. Example: ‘page.jpg’
boolean
Whether to store converted JPG files on ConvertAPI servers for up to 3 hours. Defaults to True to enable file IDs and URLs in the response for workflow chaining.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_CONVERT_UPLOAD_FILE_FROM_URLTool to upload a file directly from a remote URL. Use when you need to import files hosted on a remote server without downloading locally.

Input Parameters

string
required
Remote file URL to fetch and upload.
string
Custom identifier for the uploaded file.
string
Name for the uploaded file. Required if ‘content-disposition’ header is not set.
string
HTTP header name to send when fetching the remote URL. Must be paired with HeaderValue.
string
HTTP header value to send when fetching the remote URL. Must be paired with HeaderName.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_DOWNLOAD_FILEDownloads a converted or uploaded file from ConvertAPI using its file ID and filename, returning downloadable file content. An inline download option can be sent with the request.

Input Parameters

string
required
UUID of the stored file on ConvertAPI server.
string
Set to ‘inline’ to view the file in browser instead of downloading it. Omit or leave empty for standard download behavior.
string
required
Filename with extension for the download (e.g., ‘document.pdf’, ‘image.jpg’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_DOWNLOAD_UPLOADED_FILETool to download a previously uploaded file by its FileId. Use when you need to retrieve the original file data stored temporarily on the server (expires after 3 hours). Example prompt: “Download uploaded file with ID 25811safe8e61dd3f51ef00ee5f58b92”

Input Parameters

string
required
ID of the uploaded file to download. Must match the FileId returned by the upload endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_CONVERTER_SPECTool to retrieve the OpenAPI specification for a specific file conversion endpoint. Use when you need detailed parameter schemas and documentation for converting from one format to another.

Input Parameters

string
required
Source file format (e.g., ‘docx’, ‘pdf’, ‘jpg’). Use lowercase format extensions.
string
required
Destination file format (e.g., ‘pdf’, ‘docx’, ‘png’). Use lowercase format extensions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_FILE_INFOTool to get metadata information about a stored file without downloading it. Use when you need to check file properties like name, size, or type before downloading.

Input Parameters

string
required
ID of the file to get information about. Must match the FileId returned by the upload endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_OPENAPI_SCHEMATool to retrieve the complete OpenAPI 3.0 specification for all ConvertAPI endpoints. Use when you need comprehensive API documentation for code generation, automated testing, or understanding available conversion operations and their parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_SUPPORTED_OUTPUT_FORMATS_FOR_INPUTTool to list all output formats a given input format can be converted into. Use when you need to dynamically retrieve conversion options for a specific input format.

Input Parameters

string
required
Source file format (path parameter), e.g., ‘pdf’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_USERTool to get authenticated user account information including balance, conversions consumed, and remaining seconds. Use when you need to check account status or conversion limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_GET_USER_STATISTICSTool to retrieve usage statistics for the authenticated user account. Use when you need to analyze conversions performed during a specific date range.

Input Parameters

string
required
End date for the statistics period in YYYY-MM-DD format.
string
required
Start date for the statistics period in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVERTAPI_LIST_CONVERTERSTool to retrieve a comprehensive list of all available file converters in ConvertAPI. Use when you need to discover all supported conversion types, check which formats can be converted, or view available parameters for each converter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not