Description
With this endpoint, you can create a new image by converting an existing image to a different format. The supported image formats arejpeg
, 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.
Authorizations
API Key for authentication
Path Parameters
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
Body
The format to convert the image to. Supported formats are jpeg, png, webp, jpg.
jpeg
, png
, webp
, jpg
The name of the image to identify it on the dashboard.
1 - 30
The quality of the image to convert. It is a number between 1 and 100. If not provided, a default quality will be used.
1 <= x <= 100
Response
The API will return the 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.
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
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.
The width of the image in pixels.
The height of the image in pixels.
The format of the image. The format can be one of the following: jpeg
, png
, webp
png
, jpeg
, webp
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.
The date and time when the image was created. The date and time are in ISO 8601 format.
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.