Access Methods - IMG Processing

retrieve

Retrieves a specific image information to get information about the image, such as the image URL, the image size, or the image format.

retrieve(imageID: string, options?: RequestOptions): APIPromise<ImageObject>;

Show retrieveOptions

imageID

string

required

The unique identifier of the image to retrieve.

Show Examples

const imageObject = await client.images.retrieve('image_etm0g3x5iap4cld1qcfsjvo2');

list

Retrieves a list of all the images created by the user. The images are returned in descending order of creation date, with the most recent images first in the list.

list(query: ImageListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageListResponse>;

Show listOptions

query

object

The query parameters for listing images.

Show ImageListParams

from

string

The image ID to start from when listing images.

take

number

The number of images to return.

Show Examples

const images = await client.images.list();

delete

Deletes an image by its unique identifier, deleting all the data associated with the image, and making it unavailable for future requests.

delete(imageID: string, options?: RequestOptions): APIPromise<void>;

Show deleteOptions

imageID

string

required

The unique identifier of the image to delete.

Show Examples

await client.images.delete('image_etm0g3x5iap4cld1qcfsjvo2');

publish

Makes a private image public, so that it can be accessed by anyone. Publishing an image adds it to a CDN, allowing it to be accessed faster and more efficiently.

publish(imageID: string, options?: RequestOptions): APIPromise<ImageObject>;

Show publishOptions

imageID

string

required

The unique identifier of the image to publish.

Show Examples

const imageObject = await client.images.publish('image_etm0g3x5iap4cld1qcfsjvo2');

unpublish

Unpublishes an image that was previously published using the Publish Image endpoint. This will remove the image from the CDN and make it private again.

unpublish(imageID: string, options?: RequestOptions): APIPromise<ImageObject>;

Show unpublishOptions

imageID

string

required

The unique identifier of the image to unpublish.

Show Examples

const imageObject = await client.images.unpublish('image_etm0g3x5iap4cld1qcfsjvo2');

download

Downloads an image by its unique identifier. The image is returned as a binary response.

download(imageID: string, options?: RequestOptions): APIPromise<Response>;

Show downloadOptions

imageID

string

required

The unique identifier of the image to download.

Show Examples

const response = await client.images.download('image_etm0g3x5iap4cld1qcfsjvo2');
const content = await response.blob();
console.log(content);

Get Started

Methods