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.
Media conversion infrastructure
Convertly is built for SaaS products, internal tools, agencies, marketplaces, and creator platforms that need reliable media processing without stitching together separate file conversion, compression, storage, queue, and webhook services. Use the API for one-off upload forms, high-volume batch processing, workflow automation, or account-level media tools inside your own product.
Convertly gives your product one API for accepting user uploads, converting and compressing media, queueing large batches, packaging outputs, optionally storing generated files, and receiving signed webhook events when work is finished.
Documentation index
Quickstart
Create an API key, make your first conversion request, and queue a larger batch.
Media conversion
Convert images, video, audio, and archives into production-ready formats.
Media tools
See the toolkit Convertly can power for upload cleanup, delivery, and media workflows.
Use cases
Learn how SaaS, agencies, marketplaces, and creator tools use Convertly.
Async jobs
Upload larger batches, let workers process them, and poll status until results are ready.
Currency conversion
Convert monetary amounts with fixed-decimal handling, rate paths, and quota headers.
Webhooks
Receive signed events when conversions, file uploads, or currency requests complete.
API reference
Inspect request fields, response schemas, and playground examples.
Integration paths
For a simple form
Use
POST /api/convert or POST /api/compress when a user uploads a file and expects a direct result in the same flow.For production batches
Use
POST /api/jobs for larger workloads. Store the returned jobId, show progress, and fetch results when processing completes.For SaaS workflows
Pair async media jobs with webhooks so your app can react to completed media work automatically.
What the API handles
| Capability | What Convertly does |
|---|---|
| Upload intake | Accepts one or many files through multipart/form-data, including archive uploads that can be extracted for processing. |
| Format conversion | Converts image, video, audio, PDF, SVG, and archive outputs according to the formats enabled on your plan. |
| Compression | Reduces file size using quality-based or target-size compression while preserving compatible output formats. |
| Media tools | Supports resize presets, archive handling, output packaging, and media workflow building blocks. |
| Background processing | Queues jobs for worker processing so large batches do not block your application request cycle. |
| Storage and downloads | Returns direct download URLs by default for API requests, with optional Convertly storage when your workflow needs saved files. |
| Usage controls | Enforces plan limits for file size, files per batch, storage, concurrent jobs, and currency request volume. |
| Event delivery | Sends signed webhook events so your product can update records, notify users, or continue a workflow. |
Base URL
NEXT_PUBLIC_SITE_URL.
Request formats
The media endpoints acceptmultipart/form-data. Currency endpoints accept JSON. Authenticated developer endpoints accept either: