# Convertapi

ConvertAPI is a file conversion service that allows developers to convert various file formats, such as documents, images, and spreadsheets, into different formats programmatically.

- **Category:** documents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `CONVERTAPI`
- **Version:** 20260307_00

## Tools

### Async Convert

**Slug:** `CONVERTAPI_ASYNC_CONVERT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `File` | string | Yes | URL of the file to be converted. |
| `JobId` | string | No | Optional self-generated 32-character lowercase alphanumeric job identifier. |
| `WebHook` | string | No | Optional callback URL to receive a POST when conversion completes. |
| `source_format` | string | Yes | Source file format (path parameter), e.g., 'docx'. |
| `destination_format` | string | Yes | Destination file format (path parameter), e.g., 'pdf'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Async Job

**Slug:** `CONVERTAPI_ASYNC_DELETE_JOB`

Tool to delete a previously created asynchronous conversion job. Use when the job is no longer required to free server resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `JobId` | string | Yes | 32-character lowercase alphanumeric JobId returned by an async conversion request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Conversion Support

**Slug:** `CONVERTAPI_CHECK_CONVERSION_SUPPORT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_format` | string | Yes | Source file format to check (e.g., 'pdf', 'docx', 'jpg'). Use lowercase format extensions. |
| `destination_format` | string | Yes | Destination file format to check (e.g., 'docx', 'pdf', 'png'). Use lowercase format extensions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Uploaded File

**Slug:** `CONVERTAPI_CONVERT_DELETE_UPLOADED_FILE`

Tool to delete a previously uploaded file. Use when the file is no longer needed and should be removed from temporary storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileId` | string | Yes | ID of the uploaded file to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supported Input Formats For Output

**Slug:** `CONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUT`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `output_format` | string | Yes | Target output file format to check compatibility for. Common formats include: 'pdf', 'docx', 'jpg', 'png', 'html', 'txt', 'xlsx'. Use lowercase format extensions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert PDF to DOCX

**Slug:** `CONVERTAPI_CONVERT_PDF_TO_DOCX`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `File` | string | Yes | PDF file to convert. Provide raw binary or a publicly accessible URL. |
| `OcrMode` | string ("auto" | "force" | "never") | No | OCR behavior: 'auto', 'force', or 'never'. |
| `Timeout` | integer | No | Conversion timeout in seconds. |
| `Wysiwyg` | boolean | No | Persist exact formatting using text boxes. |
| `FileName` | string | No | Desired output DOCX file name. Required when sending raw file content. |
| `Password` | string | No | Password to open protected PDF documents. |
| `OcrEngine` | string ("native" | "tesseract") | No | OCR engine to use: 'native' or 'tesseract'. |
| `PageRange` | string | No | Page range to convert, e.g., '1-10' or '1,3,5'. |
| `StoreFile` | boolean | No | Store converted file on server and return a download URL. |
| `Annotations` | string ("textBox" | "comment" | "none") | No | How to handle PDF annotations: 'textBox' (editable text box), 'comment' (Word comments), or 'none' (omit annotations). |
| `OcrLanguage` | 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") | No | OCR language code or 'auto' for automatic detection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert PDF to JPG and Store

**Slug:** `CONVERTAPI_CONVERT_PDF_TO_JPG_AND_STORE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `File` | string | Yes | PDF source: raw file bytes, a publicly accessible URL, or a ConvertAPI file URL (e.g., 'https://v2.convertapi.com/d/FILE_ID'). |
| `FileName` | string | No | 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' |
| `StoreFile` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File From URL

**Slug:** `CONVERTAPI_CONVERT_UPLOAD_FILE_FROM_URL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Url` | string | Yes | Remote file URL to fetch and upload. |
| `FileId` | string | No | Custom identifier for the uploaded file. |
| `FileName` | string | No | Name for the uploaded file. Required if 'content-disposition' header is not set. |
| `HeaderName` | string | No | HTTP header name to send when fetching the remote URL. Must be paired with HeaderValue. |
| `HeaderValue` | string | No | HTTP header value to send when fetching the remote URL. Must be paired with HeaderName. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File

**Slug:** `CONVERTAPI_DOWNLOAD_FILE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | UUID of the stored file on ConvertAPI server. |
| `download` | string | No | Set to 'inline' to view the file in browser instead of downloading it. Omit or leave empty for standard download behavior. |
| `filename` | string | Yes | Filename with extension for the download (e.g., 'document.pdf', 'image.jpg'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Uploaded File

**Slug:** `CONVERTAPI_DOWNLOAD_UPLOADED_FILE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileId` | string | Yes | ID of the uploaded file to download. Must match the FileId returned by the upload endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Converter Spec

**Slug:** `CONVERTAPI_GET_CONVERTER_SPEC`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_format` | string | Yes | Source file format (e.g., 'docx', 'pdf', 'jpg'). Use lowercase format extensions. |
| `destination_format` | string | Yes | Destination file format (e.g., 'pdf', 'docx', 'png'). Use lowercase format extensions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File Info

**Slug:** `CONVERTAPI_GET_FILE_INFO`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileId` | string | Yes | ID of the file to get information about. Must match the FileId returned by the upload endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OpenAPI Schema

**Slug:** `CONVERTAPI_GET_OPENAPI_SCHEMA`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supported Output Formats For Input

**Slug:** `CONVERTAPI_GET_SUPPORTED_OUTPUT_FORMATS_FOR_INPUT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_format` | string | Yes | Source file format (path parameter), e.g., 'pdf'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Information

**Slug:** `CONVERTAPI_GET_USER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Statistics

**Slug:** `CONVERTAPI_GET_USER_STATISTICS`

Tool to retrieve usage statistics for the authenticated user account. Use when you need to analyze conversions performed during a specific date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endDate` | string | Yes | End date for the statistics period in YYYY-MM-DD format. |
| `startDate` | string | Yes | Start date for the statistics period in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All Converters

**Slug:** `CONVERTAPI_LIST_CONVERTERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |