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 can act as the media optimization layer for a WordPress site. The plugin is intended for normal WordPress installation from the Plugin Directory: install it, add a Convertly API key, choose optimization rules, and let new uploads optimize automatically. For most sites:
  • Enable automatic optimization
  • Optimize the original upload
  • Optimize thumbnail, medium, and large
  • Use quality 82
  • Strip metadata
  • Generate WebP
  • Generate AVIF only when your theme or CDN can serve it correctly

​
Video-heavy sites

Enable video and audio compression only when your hosting plan can tolerate heavier background work. Convertly has a server-side async jobs queue for heavy processing. WordPress uses a small scheduler to dispatch /api/jobs requests and poll for completed results, so high-volume sites should use a real server cron that triggers wp-cron.php reliably.

​
Existing media

Use Media > Bulk optimize to enqueue existing Media Library attachments, watch queue progress, and review recent job status. You can also queue existing media from Settings > Convertly Media when you are already editing optimization rules.

​
Create one-off media assets

Use Media > Convertly tools for editor-driven media work that should create a new attachment instead of replacing the source file. The tools page opens the normal WordPress Media Library picker, then lets you choose one of the Convertly tool cards:
  • Remove background
  • Convert image format
  • Raster to SVG
  • Create thumbnail
  • Watermark
  • Strip metadata
Each run sends the selected attachment to Convertly, receives the processed output, and saves the result as a new Media Library attachment. This is useful for ecommerce cutouts, campaign thumbnails, brand watermarks, SVG logo copies, and cleaned image files.

​
Quota handling

WordPress plugin usage counts against the Convertly account attached to the API key. If the site hits the per-minute limit, jobs retry with backoff. If the site hits the monthly plan quota, jobs fail with a quota message until the Convertly account is upgraded or overage billing is enabled.

​
Next steps

Recommended follow-ups for larger sites:
  • Use one API key per client site when billing or quotas need to be separated.
  • Enable webhook callbacks so WordPress can receive completed jobs without relying only on polling.
  • Test modern-format serving with the active theme, cache plugin, and CDN.