Skip to main content
POST
Transform an image

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data

Provide either file or sourceUrl.

file
file

Multipart upload input.

sourceUrl
string<uri>

Remote HTTP(S) file input. Use instead of file for single-file tools.

async
enum<string>
default:false

Set true to queue the media tool as a background job.

Available options:
true,
false
background
enum<string>

Alias for async=true.

Available options:
true,
false
width
integer
height
integer
fit
enum<string>
default:cover
Available options:
cover,
contain,
fill,
inside,
outside
rotate
number
default:0
flip
enum<string>
default:false
Available options:
true,
false
flop
enum<string>
default:false
Available options:
true,
false
cropLeft
integer
cropTop
integer
cropWidth
integer
cropHeight
integer
format
enum<string>
Available options:
jpg,
png,
webp,
avif
quality
integer
default:86
Required range: 1 <= x <= 100

Response

Generated files or queued media tool job

files
object[]
required
Last modified on July 31, 2026