ConvertAPI is a file conversion service that allows developers to convert various file formats, such as documents, images, and spreadsheets, into different formats programmatically.
ConvertAPI is a file conversion service that allows developers to convert various file formats, such as documents, images, and spreadsheets, into different formats programmatically. On Nagent, Convertapi is exposed as a fully-configurable documents integration that any agent can call — 17 actions, and API key authentication. No code is required to wire Convertapi into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Convertapi to automate the kinds of tasks documents teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Convertapi into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Convertapi, with input parameters and output schema. Drop these into any step of an agent built in Helix.
CONVERTAPI_ASYNC_CONVERTTool to perform an asynchronous file conversion. Use when converting large or long-running files to avoid client timeouts.
Input parameters
URL of the file to be converted.
Optional self-generated 32-character lowercase alphanumeric job identifier.
Optional callback URL to receive a POST when conversion completes.
Source file format (path parameter), e.g., 'docx'.
Destination file format (path parameter), e.g., 'pdf'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
32-character lowercase alphanumeric JobId returned by an async conversion request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Source file format to check (e.g., 'pdf', 'docx', 'jpg'). Use lowercase format extensions.
Destination file format to check (e.g., 'docx', 'pdf', 'png'). Use lowercase format extensions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ID of the uploaded file to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Target output file format to check compatibility for. Common formats include: 'pdf', 'docx', 'jpg', 'png', 'html', 'txt', 'xlsx'. Use lowercase format extensions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVERTAPI_CONVERT_PDF_TO_DOCXTool to convert PDF files to DOCX format. Use when you need editable Word documents from PDFs. Provide PDF content or URL and receive DOCX file metadata and download links.
Input parameters
PDF file to convert. Provide raw binary or a publicly accessible URL.
OCR behavior: 'auto', 'force', or 'never'.
Conversion timeout in seconds.
Persist exact formatting using text boxes.
Desired output DOCX file name. Required when sending raw file content.
Password to open protected PDF documents.
OCR engine to use: 'native' or 'tesseract'.
Page range to convert, e.g., '1-10' or '1,3,5'.
Store converted file on server and return a download URL.
How to handle PDF annotations: 'textBox' (editable text box), 'comment' (Word comments), or 'none' (omit annotations).
OCR language code or 'auto' for automatic detection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
PDF source: raw file bytes, a publicly accessible URL, or a ConvertAPI file URL (e.g., 'https://v2.convertapi.com/d/FILE_ID').
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'
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Remote file URL to fetch and upload.
Custom identifier for the uploaded file.
Name for the uploaded file. Required if 'content-disposition' header is not set.
HTTP header name to send when fetching the remote URL. Must be paired with HeaderValue.
HTTP header value to send when fetching the remote URL. Must be paired with HeaderName.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVERTAPI_DOWNLOAD_FILETool to download a converted or uploaded file from ConvertAPI server using its FileId. Use when you need to retrieve a previously converted or uploaded file. Set download='inline' to display in browser.
Input parameters
UUID of the stored file on ConvertAPI server.
Set to 'inline' to view the file in browser instead of downloading it. Omit or leave empty for standard download behavior.
Filename with extension for the download (e.g., 'document.pdf', 'image.jpg').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ID of the uploaded file to download. Must match the FileId returned by the upload endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Source file format (e.g., 'docx', 'pdf', 'jpg'). Use lowercase format extensions.
Destination file format (e.g., 'pdf', 'docx', 'png'). Use lowercase format extensions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ID of the file to get information about. Must match the FileId returned by the upload endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Source file format (path parameter), e.g., 'pdf'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
End date for the statistics period in YYYY-MM-DD format.
Start date for the statistics period in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 97 agents privately built on Nagent that already use Convertapi.
Build on Nagent
Connect Convertapi to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Convertapi, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Convertapi is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Convertapi is connected, you configure its 17 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Convertapi steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Convertapi event fires, the agent kicks off automatically.
Every Convertapi action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Convertapi ships with 17 pre-built documents actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Convertapi together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Convertapi-based workflows tailored to your business.