POST
/
v1
/
images
/
upload
Upload Image
curl --request POST \
  --url https://api.img-processing.com/v1/images/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form name=example-image \
  --form image=@example-file
{
  "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"
}

​
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.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
name
string
required

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

Required string length: 1 - 30
​
image
file
required

The image file to upload. It must be a valid image format (jpeg, png, webp) and not larger than 20MB.

Response

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

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.

​
id
string
required

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

​
name
string
required

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.

​
width
number
required

The width of the image in pixels.

​
height
number
required

The height of the image in pixels.

​
format
enum<string>
required

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

Available options:
png,
jpeg,
webp
​
size
number
required

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
string<date-time>
required

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

​
url
string | 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 UR.