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 designed for products that need media processing as part of a user workflow. These examples show where the API fits and which endpoints to use.
SaaS upload pipeline
Use Convertly after a user uploads a file and before the file is published in your product.
| Step | Convertly role |
|---|
| Accept upload | Receive the original file through POST /api/convert or POST /api/compress. |
| Normalize media | Convert to the format your product supports. |
| Optimize size | Compress the output so pages, galleries, and downloads stay fast. |
| Return result | Use the returned downloadUrl immediately, or enable storage when your workflow needs a stored file ID. |
Creator and agency batches
Use async jobs when users upload many files or large media that should continue processing after they leave the page.
| Need | Recommended path |
|---|
| Batch image conversion | POST /api/jobs with jobType=convert. |
| Client delivery archive | Enable archive creation for grouped outputs. |
| Progress UI | Poll GET /api/jobs/{id} while the job is pending or processing. |
| Workflow automation | Add webhooks so your app reacts when processing completes. |
Marketplace asset cleanup
Convertly can prepare product images and listing media before they are published.
| Task | Convertly capability |
|---|
| Standardize images | Convert uploads to webp, jpg, or png. |
| Reduce heavy files | Use quality or target-size compression. |
| Create consistent dimensions | Apply resize presets or custom width and height settings. |
| Avoid accidental storage | Leave API storage off by default and store only in your own system. |
| Need | Recommended Convertly flow |
|---|
| Square catalog images | POST /api/media/transform with preset=ecommerce. |
| Fast storefront delivery | Generate WebP or AVIF outputs and cache the resulting asset. |
| Zoom-ready originals | Store the original separately and publish optimized derivatives. |
| Background imports | Create async jobs with idempotency keys so retries do not duplicate work. |
Agency client delivery
Agencies often need repeatable conversion work for many brands, campaigns, and client portals.
| Need | Recommended Convertly flow |
|---|
| Bulk conversion | POST /api/jobs with jobType=convert and archive creation. |
| Client previews | Generate storyboards, poster frames, PDF previews, and watermarked review files. |
| Handoff automation | Use webhooks or per-job callbacks to notify your project system. |
| Usage controls | Track media API and processed-transfer usage from the dashboard. |
SaaS user uploads
Use Convertly as the media-processing layer behind product upload flows.
| Need | Recommended Convertly flow |
|---|
| Retry-safe uploads | Send Idempotency-Key on POST /api/jobs. |
| Avatar normalization | POST /api/media/transform with preset=avatar. |
| Social previews | POST /api/media/transform with preset=social-preview. |
| Event-driven UX | Register webhooks or pass callbackUrl on a job request. |
| Need | Recommended Convertly flow |
|---|
| WordPress uploads | Install the Convertly Media Optimizer plugin and connect an API key. |
| Editorial hero images | POST /api/media/transform with preset=blog-hero. |
| Document thumbnails | POST /api/media/pdf-preview with async=true for large files. |
| Theme/CDN delivery | Generate WebP/AVIF copies and serve them when the browser supports the format. |
| Workflow | Endpoint |
|---|
| One-off conversion | POST /api/convert |
| One-off compression | POST /api/compress |
| Large batch processing | POST /api/jobs |
| Currency utility | POST /api/currency/convert |
