Convertapi
convertapiConvertAPI is a file conversion service that allows developers to convert various file formats, such as documents, images, and spreadsheets, into different formats programmatically.
Acciones disponibles (11)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Async ConvertCONVERTAPI_ASYNC_CONVERTAcciónTool to perform an asynchronous file conversion. use when converting large or long-running files to avoid client timeouts.
CONVERTAPI_ASYNC_CONVERTAcciónTool to perform an asynchronous file conversion. use when converting large or long-running files to avoid client timeouts.
Parámetros de entrada
FileanyObligatoriouriURL of the file to be converted.
JobIdanyOptional self-generated 32-character lowercase alphanumeric job identifier.
WebHookanyuriOptional callback URL to receive a POST when conversion completes.
source_formatstringObligatorioSource file format (path parameter), e.g., 'docx'.
destination_formatstringObligatorioDestination file format (path parameter), e.g., 'pdf'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Async JobCONVERTAPI_ASYNC_DELETE_JOBAcciónTool to delete a previously created asynchronous conversion job. use when the job is no longer required to free server resources.
CONVERTAPI_ASYNC_DELETE_JOBAcciónTool to delete a previously created asynchronous conversion job. use when the job is no longer required to free server resources.
Parámetros de entrada
JobIdstringObligatorio32-character lowercase alphanumeric JobId returned by an async conversion request.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Uploaded FileCONVERTAPI_CONVERT_DELETE_UPLOADED_FILEAcciónTool to delete a previously uploaded file. use when the file is no longer needed and should be removed from temporary storage.
CONVERTAPI_CONVERT_DELETE_UPLOADED_FILEAcciónTool to delete a previously uploaded file. use when the file is no longer needed and should be removed from temporary storage.
Parámetros de entrada
FileIdstringObligatorioID of the uploaded file to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Supported Input Formats For OutputCONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUTAcciónTool to list all input formats that can convert to a specified output format. use after deciding the target output format.
CONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUTAcciónTool to list all input formats that can convert to a specified output format. use after deciding the target output format.
Parámetros de entrada
output_formatstringObligatorioDesired output file format (path parameter), e.g., 'pdf'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Convert PDF to DOCXCONVERTAPI_CONVERT_PDF_TO_DOCXAcciónTool 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.
CONVERTAPI_CONVERT_PDF_TO_DOCXAcciónTool 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.
Parámetros de entrada
FilestringObligatoriobinaryPDF file to convert. Provide raw binary or a publicly accessible URL.
OcrModestringenumOCR behavior: 'auto', 'force', or 'never'.
autoforceneverTimeoutintegerConversion timeout in seconds.
WysiwygbooleanPersist exact formatting using text boxes.
FileNamestringDesired output DOCX file name. Required when sending raw file content.
PasswordstringPassword to open protected PDF documents.
OcrEnginestringenumOCR engine to use: 'native' or 'tesseract'.
nativetesseractPageRangestringPage range to convert, e.g., '1-10' or '1,3,5'.
StoreFilebooleanStore converted file on server and return a download URL.
OcrLanguagestringenumOCR language code or 'auto' for automatic detection.
autoarcazhdanlenfifrdegrko+13
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Convert PDF to JPG and StoreCONVERTAPI_CONVERT_PDF_TO_JPG_AND_STOREAcciónTool to convert a pdf to jpg and store the result on the server. use when individual jpg pages are needed for further workflow steps.
CONVERTAPI_CONVERT_PDF_TO_JPG_AND_STOREAcciónTool to convert a pdf to jpg and store the result on the server. use when individual jpg pages are needed for further workflow steps.
Parámetros de entrada
FilestringObligatoriobinaryPDF data as raw bytes or a publicly accessible URL.
FileNamestringDesired output JPG file name when sending raw file bytes. Required if File is bytes. Example: 'page.jpg'
StoreFilebooleanMust be set to true to store converted JPG files on server for workflow processing.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload File From URLCONVERTAPI_CONVERT_UPLOAD_FILE_FROM_URLAcciónTool to upload a file directly from a remote url. use when you need to import files hosted on a remote server without downloading locally.
CONVERTAPI_CONVERT_UPLOAD_FILE_FROM_URLAcciónTool to upload a file directly from a remote url. use when you need to import files hosted on a remote server without downloading locally.
Parámetros de entrada
UrlanyObligatoriouriRemote file URL to fetch and upload.
FileIdstringCustom identifier for the uploaded file.
FileNamestringName for the uploaded file. Required if 'content-disposition' header is not set.
HeaderNamestringHTTP header name to send when fetching the remote URL. Must be paired with HeaderValue.
HeaderValuestringHTTP header value to send when fetching the remote URL. Must be paired with HeaderName.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload File (Multipart)CONVERTAPI_CONVERT_UPLOAD_FILE_MULTIPARTAcciónTool 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.
CONVERTAPI_CONVERT_UPLOAD_FILE_MULTIPARTAcciónTool 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.
Parámetros de entrada
FileanyObligatoriobinaryLocal path to the file to upload.
FileNamestringOptional override for the name of the uploaded file; if omitted, derived from the file path.
ContentTypestringOptional MIME type of the file (e.g., "application/pdf"); if omitted, guessed from the file extension.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload File (octet-stream)CONVERTAPI_CONVERT_UPLOAD_FILE_OCTET_STREAMAcciónTool to upload a file with application/octet-stream. use when you need to upload raw file data efficiently for reuse in multiple conversions.
CONVERTAPI_CONVERT_UPLOAD_FILE_OCTET_STREAMAcciónTool to upload a file with application/octet-stream. use when you need to upload raw file data efficiently for reuse in multiple conversions.
Parámetros de entrada
FilestringObligatoriobinaryRaw file bytes to upload as octet-stream.
FileNamestringObligatorioName of the file, will be set in the Content-Disposition header.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Download Uploaded FileCONVERTAPI_DOWNLOAD_UPLOADED_FILEAcciónTool 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"
CONVERTAPI_DOWNLOAD_UPLOADED_FILEAcciónTool 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"
Parámetros de entrada
FileIdstringObligatorioID of the uploaded file to download. Must match the FileId returned by the upload endpoint.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Supported Output Formats For InputCONVERTAPI_GET_SUPPORTED_OUTPUT_FORMATS_FOR_INPUTAcciónTool 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.
CONVERTAPI_GET_SUPPORTED_OUTPUT_FORMATS_FOR_INPUTAcciónTool 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.
Parámetros de entrada
source_formatstringObligatorioSource file format (path parameter), e.g., 'pdf'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not