POST
/
v1
/
images
/
{imageId}
/
convert

​
Description

With this endpoint, you can create a new image by converting an existing image to a different format.

The supported image formats are jpeg, png, and webp.

  • JPEG (Joint Photographic Experts Group): A commonly used method of lossy compression for digital images, particularly for those images produced by digital photography. JPEG compression significantly reduces the file size, but it can also reduce the image quality.
  • PNG (Portable Network Graphics): A raster-graphics file format that supports lossless data compression. PNG is often used for images that require transparency or when the image quality must be preserved without any loss.
  • WebP: A modern image format that provides superior lossless and lossy compression for images on the web. WebP images are smaller in size compared to JPEG and PNG, while maintaining similar or better image quality.

​
Request Parameters

The request path should contain the following parameters:

imageId
string
required

The ID of the image to convert.

​
Request Body

The request body should contain a JSON object with the following fields:

format
string
required

The desired format of the converted image.

Available formats: jpeg, png, webp.

quality
integer
default: "100"

The quality of the converted image if the target format is jpeg.

name
string
default: "<old name>"

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

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

Unpublish ImageCrop Image