Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.convertly.sh/llms.txt

Use this file to discover all available pages before exploring further.

Convertly is a media processing API and workspace. Your product sends files to Convertly, chooses an output format or optimization setting, and receives generated files back as download URLs. Storage is optional: synchronous API requests can return files without saving them, while async jobs and dashboard workflows can store files when your product needs a durable record.

What media conversion solves

Most products eventually need media handling that goes beyond upload and download. Users upload the wrong format, oversized images, large videos, archive folders, or files that need to become something else before they are useful. Convertly handles that processing layer so your app does not need to run image libraries, video tools, worker queues, storage bookkeeping, and webhook delivery yourself.

Main capabilities

CapabilityOutcome
Format conversionTurn uploads into supported image, video, audio, document, or archive outputs.
CompressionReduce file size with quality-based or target-size compression.
Image resizingGenerate web, email, social, ecommerce, square, width-based, or height-based outputs.
SVG tracingConvert raster images into alpha-aware SVG vectors with color preserved by default, or opt into monochrome output.
Background removalRemove image backgrounds through the Media Tools API and preserve images that already have transparent cutouts.
Archive handlingAccept ZIP inputs and extract contents for processing when the output is not another archive.
Optional storageSave uploads and outputs only when your workflow needs stored files.
Webhook deliveryNotify your product when stored media workflows complete.

Synchronous vs async

Use synchronous conversion when the user is waiting on a small number of files and you want the result immediately. Use async jobs for larger batches, heavier media, or flows where the user can leave the page while Convertly workers process the files.

Immediate results

Use POST /api/convert or POST /api/compress for direct results.

Background batches

Use the jobs API when work should continue outside the request lifecycle.

Request lifecycle

  1. Send files and settings to a conversion, compression, media tool, or jobs endpoint.
  2. Convertly validates file type, file size, plan limits, and requested output formats.
  3. Convertly processes the files with the relevant media tooling.
  4. The response includes generated file metadata and a downloadUrl.
  5. If storage is enabled, the output also appears in the Convertly file manager and includes a storedFileId.

Supported formats

Convertly supports image, video, audio, document, and archive outputs including jpg, png, webp, avif, tiff, gif, heif, svg, pdf, mp4, webm, mov, mp3, wav, ogg, m4a, flac, zip, tar, tgz, 7z, rar, gz, bz2, and xz. For raster-to-SVG output, Convertly keeps color by default and ignores low-alpha pixels so transparent logo edges do not become traced artifacts. Send mono=true on synchronous conversion requests, or monos=[true,false] for per-file batch settings, when your product specifically needs black-and-transparent tracing.

Common product flows

FlowHow Convertly fits
User-generated contentAccept uploads, normalize image or video formats, and return production-ready files.
Creator exportsConvert source assets into social, web, email, or ecommerce-ready sizes.
Marketplace listingsCompress product images and generate consistent output formats before publishing.
Agency deliveryProcess client folders, create archives, and keep completed outputs easy to download.
SaaS media pipelinesAdd conversion, compression, jobs, and webhooks without running your own media workers.