Documentation Index Fetch the complete documentation index at: https://docs.img-processing.com/llms.txt
Use this file to discover all available pages before exploring further.
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 > ;
The unique identifier of the image to retrieve.
const imageObject = await client . images . retrieve ( 'image_etm0g3x5iap4cld1qcfsjvo2' );
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 > ;
The query parameters for listing images. The image ID to start from when listing images.
The number of images to return.
const images = await client . images . list ();
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 >;
The unique identifier of the image to delete.
await client . images . delete ( 'image_etm0g3x5iap4cld1qcfsjvo2' );
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 > ;
The unique identifier of the image to publish.
const imageObject = await client . images . publish ( 'image_etm0g3x5iap4cld1qcfsjvo2' );
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 > ;
The unique identifier of the image to unpublish.
const imageObject = await client . images . unpublish ( 'image_etm0g3x5iap4cld1qcfsjvo2' );
Downloads an image by its unique identifier. The image is returned as a binary response. download ( imageID : string , options ?: RequestOptions ): APIPromise < Response > ;
The unique identifier of the image to download.
const response = await client . images . download ( 'image_etm0g3x5iap4cld1qcfsjvo2' ); const content = await response . blob (); console . log ( content );
