Skip to main content

listImages

List all images.

Parameter​

None

Returns​

An object where the keys are image names, and value values are objects with the following keys:

KeyTypeDescription
uidstringUnique ID of the image.
intentstringStorage intent.
blackModestringImage black mode. v6.0
creatednumberCreation timestamp (Unix time, seconds).
fileSizenumberImage file size in bytes.
memoryUsagenumberMemory usage in bytes.
statestringLoad state of the image: PROCESSING, READY, ERROR, or PARKED if the image is not active v5.2.
previewStatestringLoad state of the image preview.
activebooleanWhether the image is currently active.
widthnumberImage width in pixels (present when dimensions are known).
heightnumberImage height in pixels (present when dimensions are known).
formatobjectImage format, see below (present when dimensions are known).
width_mmnumberImage width in millimeters (present when dimensions are known).
height_mmnumberImage height in millimeters (present when dimensions are known).
profilestringEmbedded image color profile name (present when dimensions are known).

The image format object has the following keys:

KeyTypeDescription
colorSpacestringGRAY, RGB, or CMYK. Omitted if the color space is unknown.
alphastringNONE, STRAIGHT, or PREMULTIPLIED.
channelsnumberNumber of channels.
bitsPerChannelnumberNumber of bits per channel.

Example​

listImages