Image and PDF Compression API

We are happy to introduce the first API for images and PDF online compression with unique features such as unlimited and free sub-accounts, 1 month of media backup and restoration. We would be happy to provide some help for your API integration and product promotion, create a free account and get in touch through our private ticket system.API image optimization

Accounts

Accounts - Current account informations

 
/accounts/mine

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/mine'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

file_max_sizeInt

Max file size allowed to uplooad (in bytes)

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Current account informations

 
/accounts/mine

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/mine'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

file_max_sizeInt

Max file size allowed to uplooad (in bytes)

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Current account informations

 
/accounts/mine

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/mine'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

file_max_sizeInt

Max file size allowed to uplooad (in bytes)

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Current account consumption

 
/accounts/mine/consumption

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/mine/consumption'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
consumptionObject

object

  last_daysObject[]

Last 30 days of consumption

    dateObject

Consumption date object

      total_size_beforeObject

Sum of bytes before optimization of all files sent this day

      total_size_afterObject

Sum of bytes after optimization of all files sent this day

      files_countObject

Number of files optimized this day

  last_monthsObject[]

Last months of consumption

    dateObject

Consumption date object

      total_size_beforeObject

Sum of bytes before optimization of all files sent this month

      total_size_afterObject

Sum of bytes after optimization of all files sent this month

      files_countObject

Number of files optimized this day

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Current account consumption

 
/accounts/mine/consumption

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/mine/consumption'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
consumptionsObject[]

Consumption (Array of Objects)

  dateObject

Consumption date object

    dateInt

Consumption day

    consumptionInt

Total consumption of the day

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Subaccounts list

 
/accounts/sub/

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
itemsObjects[]

List of subaccounts (Array of Objects)

  idInt

Subaccount id

  titleString

Subaccount title

  descriptionString

Subaccount description

  quota_startDate

Subaccount first day of current month quota calculation

  quota_endDate

Subaccount last day of current month quota calculation

  quota_allowedString

Subaccount allowed monthly quota (in bytes)

  quota_currentString

Subaccount current consumption (in bytes)

  file_max_sizeString

Subaccount allowed max files size allowed to upload (in bytes)

  api_keyString

Subaccount api key

  api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Subaccounts list

 
/accounts/sub/

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
itemsObjects[]

List of subaccounts (Array of Objects)

  idInt

Subaccount id

  titleString

Subaccount title

  descriptionString

Subaccount description

  quota_startDate

Subaccount first day of current month quota calculation

  quota_endDate

Subaccount last day of current month quota calculation

  quota_allowedString

Subaccount allowed monthly quota (in bytes)

  quota_currentString

Subaccount current consumption (in bytes)

  file_max_sizeString

Subaccount allowed max files size allowed to upload (in bytes)

  api_keyString

Subaccount api key

  api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Subaccount informations

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Subaccount informations

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Create subaccount

 
/accounts/sub

Permission: need authentication through additional parameters

  curl -X POST 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	-d 'title="New subaccount"'
	-d 'description="This is my description"'
	-d 'quota="524288000"'
	'https://api.imagerecycle.com/v1/accounts/sub'

Post parameters

FieldTypeDescription
titleString

Subaccount title

descriptionString

Subaccount description

quotaInt

Subaccount allowed monthly quota (in bytes)

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 201

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Create subaccount

 
/accounts/sub

Permission: need authentication through additional parameters

  curl -X POST 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	-d 'title="New subaccount"'
	-d 'description="This is my description"'
	-d 'monthly_quota="524288000"'
	'https://api.imagerecycle.com/v1/accounts/sub'

Post parameters

FieldTypeDescription
titleString

Subaccount title

descriptionString

Subaccount description

monthly_quotaInt

Subaccount allowed monthly quota (in bytes)

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 201

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Delete subaccount

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X DELETE
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
SuccessBoolean 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Delete subaccount

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X DELETE
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
SuccessBoolean 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Edit subaccount fields

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X PUT
	-d 'title="My new title"' 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Post parameters

FieldTypeDescription
titleString

Subaccount title

descriptionString

Subaccount description

quotaInt

Subaccount allowed monthly quota (in bytes)

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Edit subaccount fields

 
/accounts/sub/:id

Permission: need authentication through additional parameters

  curl -X PUT
	-d 'title="My new title"' 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/accounts/sub/123'

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Post parameters

FieldTypeDescription
titleString

Subaccount title

descriptionString

Subaccount description

monthly_quotaInt

Subaccount allowed monthly quota (in bytes)

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Reset subaccount API secret

 
/accounts/sub/reset_secret/:id

Permission: need authentication through additional parameters

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_secret/123'

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Reset subaccount API secret

 
/accounts/sub/reset_secret/:id

Permission: need authentication through additional parameters

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_secret/123'

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Accounts - Reset subaccount consummate quota

 
/accounts/sub/reset_quota/:id

Permission: need authentication through additional parameters

Url parameters

FieldTypeDescription
idInt

account id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Subaccount id

titleString

Subaccount title

descriptionString

Subaccount description

quota_startDate

First day of current month quota calculation

quota_endDate

Last day of current month quota calculation

quota_currentInt

Current monthly consumption (in bytes)

quota_allowedInt

Monthly allowed consumption (in bytes)

quota_file_max_sizeInt

Max file size allowed to upload (in bytes)

api_keyString

Subaccount api key

api_secretString

Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_quota/123'

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images

Images - Get images list

 
/images

Permission: logged account

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/images'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
itemsObjects[]

List of images (Array of Objects)

  idInt

Image id

  filenameString

Image filename

  widthInt

Image width

  heightInt

Image height

  size_beforeInt

Image size before compression

  size_afterInt

Image size after compression

  savedFloat

Image saved proportion

  timeDate

Image creation date

  origin_urlString

{String} Image original download link

  optimized_urlString

{String} Image optimized download link

  expiration_dateDate

{String} Image expiration date

totalInt

Total number of items

prevObject

Previous pagination object

  linkString

Previous pagination link API address

  offsetInt

Previous pagination offset

  limitInt

Previous pagination limit

nextObject

Next pagination object

  linkString

Next pagination link API address

  offsetInt

Next pagination offset

  limitInt

Next pagination limit

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Get images list

 
/images

Permission: logged account

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/images'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
itemsObjects[]

List of images (Array of Objects)

  idInt

Image id

  filenameString

Image filename

  widthInt

Image width

  heightInt

Image height

  size_beforeInt

Image size before compression

  size_afterInt

Image size after compression

  savedFloat

Image saved proportion

  timeDate

Image creation date

  origin_urlString

{String} Image original download link

  optimized_urlString

{String} Image optimized download link

  expiration_dateDate

{String} Image expiration date

totalInt

Total number of items

prevObject

Previous pagination object

  linkString

Previous pagination link API address

  offsetInt

Previous pagination offset

  limitInt

Previous pagination limit

nextObject

Next pagination object

  linkString

Next pagination link API address

  offsetInt

Next pagination offset

  limitInt

Next pagination limit

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Get an image

 
/images/:id

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'https://api.imagerecycle.com/v1/images/3012'

Parameter

FieldTypeDescription
idInt

Image id

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Image id

filenameString

Image filename

widthInt

Image width

heightInt

Image height

size_beforeInt

Image size before compression

size_afterInt

Image size after compression

savedFloat

Image saved proportion

timeDate

Image creation date

origin_urlString

{String} Image original download link

optimized_urlString

{String} Image optimized download link

expiration_dateDate

{String} Image expiration date

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Get an image

 
/images/:id

Permission: need authentication through additional parameters

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'https://api.imagerecycle.com/v1/images/3012'

Parameter

FieldTypeDescription
idInt

Image id

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 200

FieldTypeDescription
idInt

Image id

filenameString

Image filename

widthInt

Image width

heightInt

Image height

size_beforeInt

Image size before compression

size_afterInt

Image size after compression

savedFloat

Image saved proportion

timeDate

Image creation date

origin_urlString

{String} Image original download link

optimized_urlString

{String} Image optimized download link

expiration_dateDate

{String} Image expiration date

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Add a new image

 
/images

Permission: need authentication through additional parameters

  curl -X POST 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	-d 'url=https://www.google.fr/images/srpr/logo11w.png' 
	-d 'params={"compression_type":"lossy"}' 
	'https://api.imagerecycle.com/v1/images'

Post parameters

FieldTypeDescription
file optionalFile

File to send

url optionalString

an URL where download the file

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 201

FieldTypeDescription
idInt

Image id

filenameString

Image filename

widthInt

Image width

heightInt

Image height

size_beforeInt

Image size before compression

size_afterInt

Image size after compression

savedFloat

Image saved proportion

timeDate

Image creation date

origin_urlString

{String} Image original download link

optimized_urlString

{String} Image optimized download link

expiration_dateDate

{String} Image expiration date

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 403 Forbidden

FieldTypeDescription
errCodeInt

403 Forbidden

errMessageString

Error message

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Add a new image

 
/images

Permission: need authentication through additional parameters

  curl -X POST 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	-d 'url=https://www.google.fr/images/srpr/logo11w.png' 
	-d 'params={"compression_type":"lossy"}' 
	'https://api.imagerecycle.com/v1/images'

Post parameters

FieldTypeDescription
file optionalFile

File to send

url optionalString

an URL where download the file

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 201

FieldTypeDescription
idInt

Image id

filenameString

Image filename

widthInt

Image width

heightInt

Image height

size_beforeInt

Image size before compression

size_afterInt

Image size after compression

savedFloat

Image saved proportion

timeDate

Image creation date

origin_urlString

{String} Image original download link

optimized_urlString

{String} Image optimized download link

expiration_dateDate

{String} Image expiration date

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 403 Forbidden

FieldTypeDescription
errCodeInt

403 Forbidden

errMessageString

Error message

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Delete an image

 
/images/:id

Permission: need authentication through additional parameters

  curl -X DELETE 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'http://imageoptimizerapi.local/v1/images/23189'

Url parameters

FieldTypeDescription
idInt

Image id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 204

FieldTypeDescription
SuccessObject 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Delete an image

 
/images/:id

Permission: need authentication through additional parameters

  curl -X DELETE 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'http://imageoptimizerapi.local/v1/images/23189'

Url parameters

FieldTypeDescription
idInt

Image id

authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 204

FieldTypeDescription
SuccessObject 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Delete all images

 
/images/all

Permission: need authentication through additional parameters

  curl -X DELETE 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'https://api.imagerecycle.com/v1/images'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 204

FieldTypeDescription
SuccessObject 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Delete all images

 
/images/all

Permission: need authentication through additional parameters

  curl -X DELETE 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 
	'https://api.imagerecycle.com/v1/images'

Url parameters

FieldTypeDescription
authjson

Authentication Object

  keyString

Authentication key

  secretString

Authentication secret

Success 204

FieldTypeDescription
SuccessObject 

Error 400 Bad Request

FieldTypeDescription
errCodeInt

The 400 http error code

errMessageString

Query error

Error 401 Unauthorized

FieldTypeDescription
errCodeInt

The http error code

errMessageString

The last error message

Images - Download a file

 
/images/:type/:token/:name

Permission: no permission required

  curl -X GET 
	'https://api.imagerecycle.com/v1/images/optimized/cd493caac5e70f154c80141fccb5ad0a/logo11w.png'

Parameter

FieldTypeDescription
typeString

Image type

Allowed values: "original", "optimized"

tokenString

Image token

Size range: ..32

nameString

Image name

Success 200

FieldDescription
Return

a file

Error 404 Not found

FieldDescription
ErrCode

404

ErrMessage

Not found

Images - Download a file

 
/images/:type/:token/:name

Permission: no permission required

  curl -X GET 
	'https://api.imagerecycle.com/v1/images/optimized/cd493caac5e70f154c80141fccb5ad0a/logo11w.png'

Parameter

FieldTypeDescription
typeString

Image type

Allowed values: "original", "optimized"

tokenString

Image token

Size range: ..32

nameString

Image name

Success 200

FieldDescription
Return

a file

Error 404 Not found

FieldDescription
ErrCode

404

ErrMessage

Not found

Images - Download a zip file

 
/images/zip/:type/:ids

Permission: no permission required

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/images/zip/optimized/1230,1231,1400'

Url parameters

FieldTypeDescription
typeString

Image type

Allowed values: "original", "optimized"

idsString

list of comma separated ids to download

Success 200

FieldDescription
Return

a zip file

Error 404 Not found

FieldDescription
ErrCode

404

ErrMessage

Not found

Images - Download a zip file

 
/images/zip/:type/:ids

Permission: no permission required

  curl -X GET 
	-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
	'https://api.imagerecycle.com/v1/images/zip/optimized/1230,1231,1400'

Url parameters

FieldTypeDescription
typeString

Image type

Allowed values: "original", "optimized"

idsString

list of comma separated ids to download

Success 200

FieldDescription
Return

a zip file

Error 404 Not found

FieldDescription
ErrCode

404

ErrMessage

Not found

 

We can help with image and PDF compression API

We have a private support ticket system with a dedicated developer that know very well the image compression because he created it. Register a free account and drop us a ticket in the API section. We can provide an account with quota for your testing purpose. API integration in new CMS or new extension for CMS are welcome as well as custom projects integrations. Note that we already have a PHP script that can be downloaded and used with our image and PDF compression API.

Compress API Update and Integration

We are proud that you choose and take time to integrate our extension/service with our API, so we can help with promotion too! by promotion we mean on our official blog, social networks and 3rd party reviews. The API is often updated depending mainly of new image format or customer needs, but we always keep in mind that an API is here to stay, so we make sure of our API code legacy.