Skip to main content
POST
/
api
/
compress
Compress files
curl --request POST \
  --url https://convertly.sh/api/compress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form files.items='@example-file'
{
  "files": [
    {
      "filename": "<string>",
      "originalSize": 123,
      "finalSize": 123,
      "savedPercent": 123,
      "mimeType": "<string>",
      "downloadUrl": "<string>",
      "appliedQuality": 123,
      "storedFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "storage": {
    "saved": true,
    "notice": "<string>"
  }
}

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.

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key.

Body

multipart/form-data
files
file[]
required
mode
enum<string>
default:quality
Available options:
quality,
target-size
modes
string

JSON array of compression modes.

quality
integer
default:82
Required range: 1 <= x <= 100
qualities
string

JSON array of quality values.

targetBytes
integer
Required range: x >= 1
targetByteValues
string

JSON array of target byte values or null.

lossless
enum<string>
default:false
Available options:
true,
false
losslessValues
string

JSON array of booleans.

stripMetadata
enum<string>
default:true
Available options:
true,
false
stripMetadataValues
string

JSON array of booleans.

saveToStorage
enum<string>
default:false

API-key requests do not save files by default. Set true to store uploads and outputs in Convertly storage.

Available options:
true,
false

Response

Compressed files

files
object[]
required
storage
object