Convertapi

Learn how to use Convertapi with Composio

Overview

SLUG

CONVERTAPI

Description

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

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: CONVERTAPI_ASYNC_CONVERT

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

Action Parameters

File
Required
JobId
WebHook
destination_format
stringRequired
source_format
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

JobId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

FileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUT

Tool to list all input formats that can convert to a specified output format. use after deciding the target output format.

Action Parameters

output_format
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

File
stringRequired
FileName
string
OcrEngine
stringDefaults to native
OcrLanguage
stringDefaults to auto
OcrMode
stringDefaults to auto
PageRange
stringDefaults to 1-2000
Password
string
StoreFile
boolean
Timeout
integerDefaults to 600
Wysiwyg
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

File
stringRequired
FileName
string
StoreFile
booleanDefaults to True

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

FileId
string
FileName
string
HeaderName
string
HeaderValue
string
Url
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CONVERTAPI_CONVERT_UPLOAD_FILE_MULTIPART

Tool to upload a file via multipart/form-data. use when you need to store a file on convertapi's servers (up to 3 hours) and obtain a fileid for subsequent conversions.

Action Parameters

ContentType
string
File
Required
FileName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CONVERTAPI_CONVERT_UPLOAD_FILE_OCTET_STREAM

Tool to upload a file with application/octet-stream. use when you need to upload raw file data efficiently for reuse in multiple conversions.

Action Parameters

File
stringRequired
FileName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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"

Action Parameters

FileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

source_format
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired