This is the AI Toolkit for the IMG Processing API. Here you will find how to use the API with AI agents, LLMs, and other AI tools.
## Tools
Select the tool you want to use from the list below.
## Using Your API Key
To authenticate your requests to the IMG Processing API, you need to include your API key in the
`x-api-key` header of your request. Here is an example of how to do this using `curl`:
```bash
curl -X GET https://api.img-processing.com/v1/images \
-H "x-api-key: YOUR_API_KEY"
-H "Content-Type: application/json"
```
Request that are not authenticated with a correct
API key will receive a `401 Unauthorized` response.
## Getting Your Production API Key
Once you are ready to go live with your application, you will need to get a production
API key. This key will have a higher rate limit, won't add a watermark to the processed images, and
images will be stored indefinitely, until you delete them.
To get your production API key, you will need to upgrade your account to a paid plan.
You can do this in the [API Dashboard](https://dashboard.img-processing.com) by clicking `Set up Billing`.
Once you have set up billing, you will be able to generate a production API key in the same page, by clicking `Get Live API Key`.
After generating the production API key, it will be displayed on the page. Make sure to copy it and store it securely,
as it will not be displayed again. We do not store your API key, so if you lose it, you will need to roll a new one.
## The Next Steps
Now that you have your API key, you can start making requests to the IMG Processing API.
Start by uploading an image and applying some transformations to it!
β¨οΈ **How does it work?**
Create a POST request to the [Blur endpoint](/api-reference/endpoints/edition/blur) with the image file and blur properties in the request body.
```bash
curl --request POST \
--url https://api.img-processing.com/v1/images/{image_id}/blur \
--header 'Content-Type: application/json' \
--header 'x-api-key: 
[
](https://app.getpostman.com/run-collection/6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c%26entityType%3Dcollection%26workspaceId%3D845670a4-96fc-43cb-8204-4cff32ab67f2#?env%5BAPI%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2Rldi1hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6ImFwaWtleSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InNlY3JldCIsInNlc3Npb25WYWx1ZSI6ImxpdmVfYWo0ZXVvZjV5OTJ0YzRweGxwZjg5bDlwdWhxYXlla2IiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiaW1hZ2VfaWQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJhbnkiLCJzZXNzaW9uVmFsdWUiOiJpbWFnZV9qbGp0eXdmMGlodmJxcnRkMHYyNGEzd20iLCJzZXNzaW9uSW5kZXgiOjJ9XQ==)
# Delete Image
Source: https://docs.img-processing.com/api-reference/endpoints/access/delete
openapi.json delete /v1/images/{image_id}
Deletes an image by its unique identifier.
### Description
Sometimes you may need to remove an image from the system. This endpoint allows you to delete an image by its unique identifier,
deleting all the data associated with the image, and making it unavailable for future requests.
Published images will no longer be accessible after deletion.
](https://app.getpostman.com/run-collection/6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c%26entityType%3Dcollection%26workspaceId%3D845670a4-96fc-43cb-8204-4cff32ab67f2#?env%5BAPI%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2Rldi1hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6ImFwaWtleSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InNlY3JldCIsInNlc3Npb25WYWx1ZSI6ImxpdmVfYWo0ZXVvZjV5OTJ0YzRweGxwZjg5bDlwdWhxYXlla2IiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiaW1hZ2VfaWQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJhbnkiLCJzZXNzaW9uVmFsdWUiOiJpbWFnZV9qbGp0eXdmMGlodmJxcnRkMHYyNGEzd20iLCJzZXNzaW9uSW5kZXgiOjJ9XQ==)
***
# Upload Image
Source: https://docs.img-processing.com/api-reference/endpoints/creation/upload
openapi.json post /v1/images/upload
Uploads an image to the API
### Description
The first step to start processing images with the IMG Processing API is
to create an [Image Object](/api-reference/endpoints/image).
You can create an Image object by uploading an image file
or by [providing a URL](/api-reference/endpoints/creation/create) to an existing image.
This endpoint allows you to create an Image object by uploading an image file.
To upload an image, you need to send a `multipart/form-data` request to the API with the image
file as a `File` object stringified in the `image` field, and `name` field with the name of the image for identification purposes.
***
# Blur Image
Source: https://docs.img-processing.com/api-reference/endpoints/edition/blur
openapi.json post /v1/images/{image_id}/blur
Apply a blur effect to an image.
***
# Modulate Image
Source: https://docs.img-processing.com/api-reference/endpoints/edition/modulate
openapi.json post /v1/images/{image_id}/modulate
Adjusts the brightness, saturation, and hue of an image.
### Description
This endpoint allows you to adjust the brightness, saturation, and hue of an image.
[Brightness](https://en.wikipedia.org/wiki/Brightness) is one of the three properties of color, along with hue and saturation. It refers to the amount of light in an image, with a high brightness making the image lighter and a low brightness making the image darker.
On the other hand, [saturation](https://en.wikipedia.org/wiki/Colorfulness) refers to the intensity of the colors in an image. A high saturation value will make the colors more vivid, while a low saturation value will make the colors more muted.
[Contrast](https://en.wikipedia.org/wiki/Contrast_\(vision\)) is the difference in brightness between the lightest and darkest parts of an image. A high contrast image will have a wide range of brightness values, while a low contrast image will have a narrow range of brightness values.
Finally, [exposure](https://en.wikipedia.org/wiki/Exposure_\(photography\)) refers to the amount of light that reaches the camera sensor when taking a photo. A high exposure value will make the image brighter, while a low exposure value will make the image darker.
***
# Remove Image Background
Source: https://docs.img-processing.com/api-reference/endpoints/edition/remove-background
openapi.json post /v1/images/{image_id}/remove-background
Remove the background from an image.
***
# Image Object
Source: https://docs.img-processing.com/api-reference/endpoints/image
The main object used to represent images in the IMG Processing API
## Definition
The Image object represents an image processed using the IMG Processing API. The object contains
information about the image, such as its URL, size, and format. The Image object is returned in the response body of
all image processing requests.
## Example Image Object
The following json object represents an Image object:
```json
{
"id": "image_etm0g3x5iap4cld1qcfsjvo2",
"name": "Processed Image",
"url": "https://storage.img-processing.com/images/image_etm0g3x5iap4cld1qcfsjvo2",
"width": 460,
"height": 460,
"format": "jpeg",
"size": 282000,
"created_at": "2021-09-01T12:00:00.000Z"
}
```
## Attributes
Now you saw an example of an Image object, let's dive into the attributes that make up the object.
***
# Mirror Image
Source: https://docs.img-processing.com/api-reference/endpoints/transformation/mirror
openapi.json post /v1/images/{image_id}/mirror
Creates a new image by mirroring the original image horizontally or vertically.
### Description
With this endpoint, you can mirror an existing image horizontally or vertically to create a new image.
Mirror an image horizontally means that the image is mirrored along the vertical axis, while flipping an
image vertically means that the image is mirrored along the horizontal axis. You can also mirror an image
horizontally and vertically at the same time using the mode `both`.
***
# Resize Image
Source: https://docs.img-processing.com/api-reference/endpoints/transformation/resize
openapi.json post /v1/images/{image_id}/resize
Creates a new image by resizing an existing image
* `fill`: The image is resized to fill the specified dimensions, stretching/squishing the image to fit the provided dimensions.
This is the default fit mode.
* `contain`: The image is resized to fit within the specified dimensions, maintaining the aspect ratio, and adding
a letterbox if necessary.
* `cover`: The image is resized to cover the specified dimensions, maintaining the aspect ratio, cropping/clipping
the image if necessary.
Additionally, you can specify the background color for the letterbox when using the `contain` fit mode, and
the gravity for cropping or positioning the image when using the `cover` and `contain` fit modes.
The next image shows the available gravity modes with a white `letterbox_color` and a `contain` fit mode:
***
# Rotate Image
Source: https://docs.img-processing.com/api-reference/endpoints/transformation/rotate
openapi.json post /v1/images/{image_id}/rotate
Creates a new image by rotating the original image
### Description
This endpoint creates a new image by rotating the original image.
***
# OpenAPI Spec
Source: https://docs.img-processing.com/api-reference/explore/openapi-spec
Reference the OpenAPI spec for the API
## Description
The [OpenAPI](https://spec.openapis.org/oas/v3.1.0.html) spec is a standard way to describe RESTful APIs.
It provides a machine-readable format that can be used to generate documentation, client libraries, and server stubs.
The OpenAPI spec is a JSON or YAML file that describes the endpoints, request and response formats, authentication methods, and other details of the API.
## Download
You can download the OpenAPI spec for the IMG Processing API from the link below.
Then, copy your api key on the dashboard and replace it on the `x-api-key` field, and replace the `image` field with the path to the image you want to use as a watermark.
```bash
curl -X POST "https://api.img-processing.com/v1/images" \
-H "x-api-key: YOUR_API_KEY" \
-F "image=@logo.png" \
-F "name=watermark-logo"
```
This will return an image object with the watermark image.
```json
{
"id":"image_za9vcdw6yajjyg77v5kkf3bn",
"name":"watermark-logo",
"url":null,
"width":1515,
"height":1505,
"format":"png",
"size":1939304,
"created_at":"2025-04-01T16:52:32.503Z"
}
```
Now, we have our watermark image created, and we can apply it to an image.
## Uploading our Image
The next step is to upload the image we want to apply the watermark to. For this, we'll use the `upload` endpoint again.
This time, we'll use the following image:
```bash
curl -X POST "https://api.img-processing.com/v1/images" \
-H "x-api-key: YOUR_API_KEY" \
-F "image=@cat2.png" \
-F "name=cat-image"
```
This will return an image object with the image we want to apply the watermark to.
```json
{
"id":"image_iv7d1rish0ymrmk7qwuht3ap",
"name":"cat-image",
"url":null,
"width":1024,
"height":1024,
"format":"png",
"size":1427326,
"created_at":"2025-04-01T16:15:44.212Z"
}
```
Now, we have our watermark image and our image created, and we can apply the watermark to the image.
## Applying the Watermark
To apply the watermark to the image, we'll use the `watermark` endpoint.
## Try it yourself
You can try this on the Postman collection.
## Making a Request
Once you get the api key, you can authenticate request to the API, just include your API key in the x-api-key header of your request. Here is an example of how to do this using curl:
```bash
curl -X GET https://api.img-processing.com/v1/images \
-H "x-api-key: YOUR_API_KEY"
-H "Content-Type: application/json"
```
If you prefer it, you can also fork the Postman Library and do the request from there:
[](https://app.getpostman.com/run-collection/6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c%26entityType%3Dcollection%26workspaceId%3D845670a4-96fc-43cb-8204-4cff32ab67f2#?env%5BAPI%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2Rldi1hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6ImFwaWtleSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InNlY3JldCIsInNlc3Npb25WYWx1ZSI6ImxpdmVfYWo0ZXVvZjV5OTJ0YzRweGxwZjg5bDlwdWhxYXlla2IiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiaW1hZ2VfaWQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJhbnkiLCJzZXNzaW9uVmFsdWUiOiJpbWFnZV9qbGp0eXdmMGlodmJxcnRkMHYyNGEzd20iLCJzZXNzaW9uSW5kZXgiOjJ9XQ==)
Or you can use the playground in the documentation. For example, let's create an image from a prompt using the documentation playground!
](https://app.getpostman.com/run-collection/6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D6263667-a1fd2c1b-fe7b-4a05-87c1-6e0172caa20c%26entityType%3Dcollection%26workspaceId%3D845670a4-96fc-43cb-8204-4cff32ab67f2#?env%5BAPI%5D=W3sia2V5IjoiaG9zdCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJodHRwczovL2Rldi1hcGkuaW1nLXByb2Nlc3NpbmcuY29tIiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6ImFwaWtleSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6InNlY3JldCIsInNlc3Npb25WYWx1ZSI6ImxpdmVfYWo0ZXVvZjV5OTJ0YzRweGxwZjg5bDlwdWhxYXlla2IiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiaW1hZ2VfaWQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJhbnkiLCJzZXNzaW9uVmFsdWUiOiJpbWFnZV9qbGp0eXdmMGlodmJxcnRkMHYyNGEzd20iLCJzZXNzaW9uSW5kZXgiOjJ9XQ==)
After doing it, just run send! This will return an image object in the response.
Here is everything you need to start. If you want to make more complex tasks, don't hesitate to checkout the documentation.
# Remove Image Background
Source: https://docs.img-processing.com/api-reference/guides/remove-image-background
Remove the background of an image
One of the main functionalities of IMG Processing is the background removal feature, being one of the best on the whole internet,
in quality and price, being x50 cheaper than tools like RemoveBG, and getting awesome results.
In this guide, we'll see how to remove the background of an image using the API.
## Creating an Image
All the images in IMG Processing, must be created. To create an image you can upload one from your computer, by an url from an allowed origin, or create one from a prompt.
Let's create an image by uploading one from your computer. We'll use the curl command to do this since it's the more generic way to do it, but you can use any other tool you want.
First, download the image you want to remove the background from. Here we'll use a cat image.
Then, copy your api key on the dashboard and replace it on the `x-api-key` field, and replace the `image` field with the path to the image you want to remove the background from.
```bash
curl -X POST "https://api.img-processing.com/v1/images" \
-H "x-api-key: YOUR_API_KEY" \
-F "image=@cat2.png" \
-F "name=cat-image"
```
After doing it, just run send! This will return an image object in the response.
```json
{
"id":"image_iv7d1rish0ymrmk7qwuht3ap",
"name":"cat-image",
"url":null,
"width":1024,
"height":1024,
"format":"png",
"size":1427326,
"created_at":"2025-04-01T16:15:44.212Z"
}
```
Now, we have the image created, and we can remove the background.
## Try it yourself
You can try this on the Postman collection.
Then, copy your api key on the dashboard and replace it on the `x-api-key` field, and replace the `image` field with the path to the image you want to use as a watermark.
```bash
curl -X POST "https://api.img-processing.com/v1/images" \
-H "x-api-key: YOUR_API_KEY" \
-F "image=@logo.png" \
-F "name=resize-logo"
```
This will return an image object with the resize-logo image.
```json
{
"id":"image_za9vcdw6yajjyg77v5kkf3bn",
"name":"resize-logo",
"url":null,
"width":1515,
"height":1505,
"format":"png",
"size":1939304,
"created_at":"2025-04-01T16:52:32.503Z"
}
```
Now, we have our image created, we can resize it.
## Resizing the Image
To create a thumbail we would like to resize the image to 200x200 pixels. For this, we'll use the `resize` endpoint.
## Try it yourself
You can try this on the Postman collection.
This powerful and flexible API provides a wide range of
image manipulation and analysis capabilities, allowing developers to integrate advanced image processing
features into their applications with ease.
## Key Features
The IMG Processing API is a RESTful API that provides a wide range of image processing capabilities.
Some of the key features of the API include:
We have implemented a nice SDK that provides a simple and easy-to-use way to interact with the IMG Processing API, a powerful and flexible API provides a wide range of
image manipulation and analysis capabilities, allowing developers to integrate advanced image processing
features into their applications with ease.
## Key Features
The IMG Processing API is a RESTful API that provides a wide range of image processing capabilities.
Some of the key features of the API include: