Skip to main content

Interface: ApiImageConfig

Configuration for image generation flows of Mimeeq API

Properties

imageConfigurations?

optional imageConfigurations: object

Configuration object allows to specify different settings for various image generation contexts

ar?

optional ar: ApiImageConfigSettings

arModular?

optional arModular: ApiImageConfigSettings

basket?

optional basket: ApiImageConfigSettings

basketModular?

optional basketModular: ApiImageConfigSettings

favourites?

optional favourites: ApiImageConfigSettings

favouritesModular?

optional favouritesModular: ApiImageConfigSettings

finishEventModular?

optional finishEventModular: ApiImageConfigSettings

modularLastSession?

optional modularLastSession: ApiImageConfigSettings

pdf?

optional pdf: ApiImageConfigSettings

pdfModular?

optional pdfModular: ApiImageConfigSettings


postprocessImage()?

optional postprocessImage: (base64, extension, dimensions) => Promise<Nullable<string>>

Parameters

base64: string

A base64-encoded string representing the generated image

extension: string

The file extension of the generated image (e.g., 'png', 'jpg')

dimensions: Dimensions

An object containing the dimensions of the generated image, including width and height

Returns

Promise<Nullable<string>>

String containing base64 representation of the image to use or null if no image