CloudConvert

Add a text or image watermark to a PDF, image, or video file. Pass the source using file. Optionally pass an image with a transparent background using watermark_image; configure text watermarks and other format-specific settings through options. The output is returned as a downloadable HTTPS resource link. WORKFLOW: - Use getOperations (operation=watermark, include=options) to discover available options. - Pass the source file and, for image watermarks, watermark_image. - Use options for format-specific settings such as watermark text, position, size, or opacity.

Convert a website to PDF or capture it as a PNG or JPG screenshot. Pass the public website URL and desired output format. The output is returned as a downloadable HTTPS resource link. WORKFLOW: - Use getOperations (operation=capture-website, include=options) to discover available options. - Pass the website URL and output format.

Convert a file to a different format. Pass an uploaded file using the file parameter. The output is returned as a downloadable HTTPS resource link. WHEN TO USE: Use this tool when you want to convert a single file to a different format. Common use cases: - Convert a PDF file to a PNG, JPG or WEBP image. - Convert a PDF file to a DOCX file. - Convert a DOCX file to a PDF file. - Convert a PDF file to a MD file. WHEN NOT TO USE: - For other operations than the "convert" CloudConvert operation. WORKFLOW: - Use getOperations (operation=convert, include=options) to discover available operations and options. - Make sure the input file is available as URL (file:// URLs are not supported) - Use the convertFile tool to convert the file.

Create a ZIP, RAR, 7Z, TAR, TAR.GZ, or TAR.BZ2 archive containing uploaded files. WORKFLOW: - Collect the files to include in the archive. - Choose the required output_format. - Optionally use getOperations (operation=archive, include=options) to discover archive options. - Call this tool and download the resulting archive resource.

Create a CloudConvert job by sending an arbitrary JSON payload to the /v2/jobs API endpoint. Use this for advanced workflows with custom task graphs. Use the CloudConvert API documentation (https://cloudconvert.localhost/docs/llms.txt) to understand the payload schema. WHEN TO USE: Use this tool when you want to create a job with a custom task graph. Common use cases: - Bulk convert files with a custom task graph. - Import/export to custom storage services like S3, Azure Blob Storage, etc. - User provided job payloads. WHEN NOT TO USE: For just converting files. Instead, use the specific tools, which are simple wrappers around the createJob tool. WORKFLOW: - Decide which operation you need and check the CloudConvert API documentation to understand the payload schema. - Use getOperations to discover available operations and options. - Make sure the input file is available as URL (file:// URLs are not supported) - Create a job payload with the operations and options you need and pass it to the createJob tool. Therefore, use import/url to pass the input file as URL. Add an export/url task to the job payload to get the output file as URL.

Create a PNG, JPG, or WEBP thumbnail from an input file. Pass the source using file and configure dimensions and fitting behavior through options. The output is returned as a downloadable HTTPS resource link. WORKFLOW: - Use getOperations (operation=thumbnail, include=options) to discover available formats and options. - Pass the source file, output format, and options such as width, height, and fit.

Execute a custom ffmpeg, ImageMagick, or GraphicsMagick command. Imported files are available under /input/import_N/ and files written to /output/ are exported. WORKFLOW: - Choose the command engine and optionally attach input files. - Reference attached files under /input/import_N/<filename> in array order. - Configure the command to write result files to /output/. - Call this tool and use the returned resource links or captured console output.

Extract ExifTool metadata from a file, such as PDF page count or image/video resolution. This operation consumes no conversion credits. WORKFLOW: - Pass the file whose metadata you want to inspect. - Optionally specify input_format or metadata extraction options. - Read the extracted metadata from the metadata task result.

Get the status of a CloudConvert job by its ID. Use this to check progress or retrieve results of an existing job. This tool returns the complete API response from the /v2/jobs/<job_id> endpoint with the given schema.

List CloudConvert jobs, optionally filtered by status or tag. Tasks can be included in each job using the include parameter.