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.

Use archive workflows when your users upload folders, grouped product assets, client delivery packages, or exported media sets.

​
Choose the right flow

FlowEndpoint
Convert one archive format to anotherPOST /api/convert
Extract a ZIP and convert supported files insidePOST /api/convert
Process a large archive in the backgroundPOST /api/jobs
Return one archive for a completed batchPOST /api/jobs with createArchive=true

​
Convert an archive

curl -X POST "https://convertly.sh/api/convert" \
  -H "Authorization: Bearer $CONVERTLY_API_KEY" \
  -F "files=@./assets.zip" \
  -F "format=tgz"

​
Process a ZIP as a batch

curl -X POST "https://convertly.sh/api/convert" \
  -H "Authorization: Bearer $CONVERTLY_API_KEY" \
  -F "files=@./images.zip" \
  -F "format=webp" \
  -F "resize=website" \
  -F "compression=82"

​
Queue a larger archive

curl -X POST "https://convertly.sh/api/jobs" \
  -H "Authorization: Bearer $CONVERTLY_API_KEY" \
  -F "jobType=convert" \
  -F "saveToStorage=true" \
  -F "createArchive=true" \
  -F "files=@./client-delivery.zip" \
  -F 'formats=["webp"]' \
  -F 'compressions=[82]' \
  -F 'resizes=["website"]'
Async archive jobs return a jobId. Poll GET /api/jobs/{id} or subscribe to webhooks for completion.