Access Methods

Deletes an image by its unique identifier.

deleteImage(options: DeleteOptions): Promise<void>;

await client.deleteImage({ image_id: 'image_id' });

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

download(options: DownloadOptions): Promise<Blob>;

const blob = await client.download({ image_id: 'image_id' });

Retrieves an image object by its unique identifier.

getImage(options: GetImageOptions): Promise<ImageObject>;

const image = await client.getImage({ image_id: 'image_id' });

Retrieves a list of image objects.

listImages(options: ListImagesOptions): Promise<PaginatedImages>;

const images = await client.listImages({ take: 10 });

Publish an image, making it publicly accessible. Published images can be accessed by anyone with the URL.

publish(options: PublishOptions): Promise<void>;

await client.publish({ image_id: 'image_id' });

Unpublish an image, making it private. Unpublished images can only be accessed by authenticated users.

unpublish(options: UnpublishOptions): Promise<void>;

await client.unpublish({ image_id: 'image_id' });