Skip to main content
POST
Image Compressor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioFile
string
required

Image

ioQuality
number

Quality

Required range: 1 <= x <= 100
ioMaxWidth
number

Max width (px)

Required range: 1 <= x <= 10000
ioMaxHeight
number

Max height (px)

Required range: 1 <= x <= 10000
ioOutputFormat
enum<string>

Output format

Available options:
auto,
jpeg,
png
ioBackground
string

Background for JPEG

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.