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

Response

201
application/json

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.