POST
/
v1
/
images
/
upload
POST /v1/images/upload HTTP/1.1
Host: https://api.img-processing.com
x-api-key: <api-key>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="name"

My Image Name
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="image"; filename="image.jpg"
Content-Type: image/jpeg

< ./path/to/your/image.jpg
------WebKitFormBoundary7MA4YWxkTrZu0gW--
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "example-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}

​
Description

The first step to start processing images with the IMG Processing API is to create an Image Object. You can create an Image object by uploading an image file or by providing a URL 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.

​
Headers

​
Content-Type
string
required

The content type of the request body. Must be multipart/form-data.

​
Request Body

The request body should contain a multipart/form-data object with the following fields:

​
name
string
required

The name of the image to identify it on the dashboard.

​
image
file
required

The image file to upload.

​
Response

The API will return the created Image object in the response body.

​
id
image_{string}

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

​
name
string

The name of the image. This name is provided when uploading the image and is the way the image is identified in your account. It is not unique, in fact, each transformation you make to an image will create a new image with the same name.

​
url
url | null

The public URL of the image. By default, this URL is not available and will be null. You can make the image public by using the publish endpoint. Once the image is public, the URL will be updated with the public URL.

​
width
integer

The width of the image in pixels.

​
height
integer

The height of the image in pixels.

​
format
jpeg | png | webp

The format of the image. The format can be one of the following: jpeg, png, webp.

We are constantly adding new formats to the API, so make sure to check the latest documentation for the most up-to-date list of supported formats.

​
size
integer

The estimated size of the image in bytes. The size is an estimate and may not be exact since images can be compressed or optimized depending on the format and quality settings used during processing.

​
created_at
datetime

The date and time when the image was created. The date and time are in ISO 8601 format.

POST /v1/images/upload HTTP/1.1
Host: https://api.img-processing.com
x-api-key: <api-key>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="name"

My Image Name
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="image"; filename="image.jpg"
Content-Type: image/jpeg

< ./path/to/your/image.jpg
------WebKitFormBoundary7MA4YWxkTrZu0gW--
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "example-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}