Skip to main content
POST
Compress files

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

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
Last modified on July 31, 2026