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.
Every media tool accepts file (multipart upload) or sourceUrl (remote URL) as input. Add async=true to queue heavier work as a background job.
Common fields
These fields are accepted by most tools:
| Field | Type | Default | Description |
|---|
file | file | — | Multipart file upload. |
files | file[] | — | Multiple file uploads (image-to-PDF only). |
sourceUrl | string | — | Remote HTTP(S) URL to process without re-uploading. |
async | boolean | false | Queue as a background job. Returns a jobId. |
callbackUrl | string | — | HTTPS URL to call when an async job completes. |
callbackSecret | string | — | Secret included in async callback signatures. |
POST /api/media/transform
Resize, crop, rotate, flip, and re-encode images.
| Field | Type | Default | Description |
|---|
preset | string | — | ecommerce, avatar, blog-hero, social-preview. Overrides width, height, fit, format, and quality. |
format | string | webp | jpg, png, webp, avif. |
width | number | 0 | Output width in pixels. 0 means no resize. |
height | number | 0 | Output height in pixels. 0 means no resize. |
fit | string | cover | cover, contain, fill, inside, outside. |
quality | number | 86 | 1–100. Ignored for PNG unless lossy WebP/AVIF. |
rotate | number | 0 | Rotation in degrees. |
flip | boolean | false | Flip vertically. |
flop | boolean | false | Flip horizontally. |
cropLeft | number | 0 | Crop origin X in pixels. |
cropTop | number | 0 | Crop origin Y in pixels. |
cropWidth | number | 0 | Crop width in pixels. |
cropHeight | number | 0 | Crop height in pixels. |
Preset defaults
| Preset | Width | Height | Fit | Format | Quality |
|---|
ecommerce | 1600 | 1600 | inside | webp | 84 |
avatar | 512 | 512 | cover | webp | 86 |
blog-hero | 1600 | 900 | cover | webp | 84 |
social-preview | 1200 | 630 | cover | jpg | 88 |
Adjust
POST /api/media/adjust
Change brightness, contrast, saturation, hue, and apply filters.
| Field | Type | Default | Description |
|---|
format | string | webp | jpg, png, webp for images. mp4, webm, mov for video. mp3, m4a, wav for audio. |
quality | number | 86 | 1–100. |
brightness | number | 1 | 1 is no change. Image and video only. |
contrast | number | 1 | 1 is no change. Image and video only. |
saturation | number | 1 | 1 is no change. Image and video only. |
hue | number | 0 | Degrees. Image and video only. |
grayscale | boolean | false | Convert to grayscale. |
sharpen | boolean | false | Apply sharpening. Image only. |
invert | boolean | false | Invert colors. Image and video only. |
volume | number | 1 | 0–4. Audio only. |
normalize | boolean | false | Normalize audio levels. Audio only. |
fadeIn | number | 0 | Fade-in duration in seconds. Audio only. |
fadeOut | number | 0 | Fade-out duration in seconds. Audio only. |
Compress
POST /api/compress
Reduce file size with quality-based or target-size compression.
| Field | Type | Default | Description |
|---|
mode | string | quality | quality or target-size. |
quality | number | 82 | 1–100. Used when mode=quality. |
targetBytes | number | — | Target file size in bytes. Used when mode=target-size. |
lossless | boolean | false | Lossless compression where the format supports it. |
stripMetadata | boolean | true | Remove EXIF and container metadata. |
Watermark
POST /api/media/watermark
Add text or logo watermarks to images and short videos.
| Field | Type | Default | Description |
|---|
text | string | — | Watermark text. Required for text watermarks. |
position | string | bottom-right | top-left, top-right, bottom-left, bottom-right, center. |
opacity | number | 0.72 | 0–1. |
margin | number | 32 | Padding from the edge in pixels. |
format | string | webp | Output format. |
quality | number | 82 | 1–100. |
Thumbnail
POST /api/media/thumbnail
Generate thumbnails from images or videos.
| Field | Type | Default | Description |
|---|
format | string | webp | jpg, png, webp, avif. |
width | number | 512 | Thumbnail width. |
height | number | 512 | Thumbnail height. |
fit | string | cover | cover, contain, inside. |
quality | number | 82 | 1–100. |
Background removal
POST /api/media/remove-background
Segment foreground subjects and return a transparent image.
| Field | Type | Default | Description |
|---|
format | string | png | png, webp, jpg. Use png or webp for transparency. |
model | string | medium | fast, medium, high. Higher is slower and more accurate. |
force | boolean | false | Re-segment even if the image already has transparency. |
Poster frame
POST /api/media/poster-frame
Extract a single frame from a video at a timestamp.
| Field | Type | Default | Description |
|---|
timestamp | number | 0 | Frame time in seconds. |
format | string | jpg | jpg, png, webp. |
quality | number | 82 | 1–100. |
width | number | 0 | Max width. 0 means source width. |
POST /api/media/extract-audio
Pull the audio track from a video file.
| Field | Type | Default | Description |
|---|
format | string | mp3 | mp3, m4a, wav, ogg, flac. |
Trim
POST /api/media/trim
Cut a video or audio clip by start time and duration.
| Field | Type | Default | Description |
|---|
start | number | 0 | Start time in seconds. |
duration | number | — | Duration in seconds. If omitted, trims to the end. |
format | string | — | Output format. Inherits source format if omitted. |
Storyboard
POST /api/media/storyboard
Generate a tiled contact sheet of video frames.
| Field | Type | Default | Description |
|---|
columns | number | 4 | Frames per row. |
rows | number | 4 | Rows in the grid. |
interval | number | — | Seconds between frames. Defaults to evenly spaced across the video. |
format | string | jpg | jpg, png, webp. |
quality | number | 82 | 1–100. |
width | number | 0 | Max width of the final sheet. 0 means auto. |
Video to GIF
POST /api/media/gif
Create an animated GIF preview from a video.
| Field | Type | Default | Description |
|---|
start | number | 0 | Start time in seconds. |
duration | number | 3 | Duration in seconds. |
fps | number | 10 | Frames per second. |
width | number | 480 | Output width in pixels. |
quality | number | 82 | 1–100. |
PDF preview
POST /api/media/pdf-preview
Render a PDF page to an image.
| Field | Type | Default | Description |
|---|
page | number | 1 | Page number to render. |
format | string | jpg | jpg, png, webp, avif. |
quality | number | 82 | 1–100. |
width | number | 0 | Max width. 0 means source width. |
Image to PDF
POST /api/media/image-to-pdf
Package one or more images into a single PDF.
| Field | Type | Default | Description |
|---|
title | string | — | PDF document title. |
quality | number | 82 | 1–100. JPEG quality for embedded images. |
Inspect
POST /api/media/inspect
Return metadata without modifying the file.
| Field | Type | Default | Description |
|---|
file | file | — | The file to inspect. |
sourceUrl | string | — | Remote URL to inspect. |
POST /api/media/strip-metadata
Remove EXIF, GPS, and container metadata.
| Field | Type | Default | Description |
|---|
file | file | — | The file to process. |
sourceUrl | string | — | Remote URL to process. |
Vectorization (raster to SVG)
POST /api/convert with format=svg
Trace raster images into scalable SVG vectors.
| Field | Type | Default | Description |
|---|
vectorize | string | — | gradient to trigger SVG tracing. |
mono | boolean | false | true for monochrome black-on-transparent output. false preserves original colors. |
