API Introduction
ImageKit.io offers REST API so that you can programmatically integrate ImageKit.io in your application. Currently, we offer APIs for:
    1.
    Uploading files in the Media library.
    2.
    Updating files details, e.g., tags and custom coordinates for cropping.
    3.
    Listing and searching files in the Media library by file/folder name, tags.
    7.
    Purging cache on CDN.
    8.
    Getting image metadata for an image file.
    9.
    Bulk add or remove tags.
    10.
    Copy or move files.
    11.
    Copy or move folder.
    12.
    Get bulk job status for copy and move folder jobs.

Request and response encoding

Except for upload API, all our APIs accept JSON-encoded request bodies and returns JSON-encoded response.

Run in Postman

We’ve created a Postman collection to make testing and working with our API simpler.

Error codes

ImageKit.io API uses standard HTTP error codes.
Error code
Description
2xx OK
Everything worked as expected.
400 Bad request
The request was unacceptable, often due to missing or invalid parameter(s). In this case, a JSON-encoded error response is returned with the message property. message contains the details about the error and possible solution.
401 Unauthorized
No valid API key was provided.
403
Forbidden
Can be for the following reasons which will be indicated in the messagefield in the response:
    ImageKit could not authenticate your account with the keys provided.
    An expired key (public or private) was used with the request.
    The account is disabled.
    If you are using the upload API, the total storage limit (or upload limit) is exceeded.
429 Too Many Requests
Too many requests hit the API too quickly. We recommend you throttle the request rate as per the value of X-RateLimit-Limit and X-RateLimit-Reset response headers and stay within rate limits.
500, 502, 503, 504 Server error
Something went wrong with ImageKit.io API. Please create a support ticket by emailing us at [email protected].

Request ID (x-ik-requestId)

All API response contains a x-ik-requestId header. The value of this header is a unique identifier associated with the API request. If you face any issues with any API, then provide this header value in your support ticket to help us troubleshoot the issue quickly.
Last modified 2mo ago