Navigation overview
| Section | Path | What you do here |
|---|---|---|
| Home | /app | Recent files, quick actions, workspace overview |
| Assets | /app/files | Upload, folders, share links, cloud import, lightbox preview |
| Convert | /app/convert | Batch format conversion (same options as POST /api/convert) |
| Compress | /app/compress | Quality and target-size compression |
| Forma AI | /app/forma-ai | Generate, edit, upscale, and restyle images in the studio |
| Workflows | /app/workflows | Visual pipelines with test runs and live async execution |
| History | /app/history | Past conversion jobs, workflow runs, and apply logs |
| Image CDN | /app/image-cdn | Delivery namespaces, Transform Lab, origins, presets, domains, purge |
| Sources | /app/sources | HTTPS and bucket origins the CDN fetches from |
| Streams | /app/video-streams | Adaptive HLS video encoding and playback setup |
| Integrations | /app/integrations | WordPress and other first-party connectors |
Recommended first-time flow
Upload or import assets
Go to Assets and upload samples, or connect Google Drive / SharePoint & OneDrive under Settings → Connections and import from cloud storage.
Try Transform Lab
Open Image CDN → Transform Lab (direct link). Pick a delivery namespace, reference a stored file or origin path, preview posters/clips/image transforms, and copy the production URL.
Run a conversion batch
Use Convert or Compress for one-off batches. Results can stay in Assets when storage is available on your plan.
Create an API key
Settings → API keys → create a key and store it as
CONVERTLY_API_KEY on your server. CDN signing keys are managed separately under Image CDN → Delivery.Image CDN console tabs
| Tab | Purpose |
|---|---|
| Overview | Delivery URL pattern and workspace summary |
| Transform Lab | Live preview for image and video CDN transforms |
| Delivery | Namespaces, signing keys, and delivery modes (public / signed / private) |
| Origins | Managed library and external origin configuration |
| Presets | Named transform parameter sets (?preset=hero) |
| Purge cache | Invalidate cached CDN URLs after source changes |
| Domains | Custom hostnames for CDN delivery (Pro and Business) |
@convertly-sh/image.
Assets and sharing
- Folders: organize uploads; drag-and-drop moves files between folders.
- Share folder: right-click a folder to create a time-limited public read-only link (
convertly.sh/share/folder/...). - Archive: select files or a folder to package a zip/tar/tgz archive (large folders run as background jobs).
- Media editor: open a stored file to run cutout, vectorize, expand, and other tools from the file actions menu.
Forma AI studio
Forma AI is the dashboard surface for generative image work. separate from CDN URL params likeupscale=ai, which bill through signed delivery URLs.
Studio outputs can be saved to Assets. The same capabilities are available through POST /api/ai/transform for programmatic use. See Forma AI.
Workflows and History
Workflows chain steps such as upload → convert → compress → save to storage → webhook. Use Test run with sample media before enabling live runs. Live runs return a run ID immediately and finish asynchronously. History shows conversion jobs, workflow runs, and tool applications so you can audit what ran and re-download outputs. See Workflows for the REST API (/api/workflows).
When to use the API instead
| Dashboard | API |
|---|---|
| Manual batches and exploration | Product upload pipelines (POST /api/convert, POST /api/compress) |
| Transform Lab URL copy | Programmatic CDN URLs via @convertly-sh/image or signing endpoints |
| Workflow test runs | POST /api/workflows/{id}/run from your backend |
| Settings webhooks UI | Same endpoints documented in Webhooks |
API quickstart
Platform paths, endpoint map, and first authenticated requests.