Interface: AIFreeboxImageParams

Defined in: src/aifreebox/aifreebox.ts:14

The AIFreeboxImageParams interface defines the parameters for the AIFreeboxImage function, which is used to generate or manipulate images based on specific criteria.

Properties

prompt

prompt: string

Defined in: src/aifreebox/aifreebox.ts:15

The main input string that provides context or instructions for generating the image. This value is required to facilitate image creation.

aspectRatio?

optional aspectRatio: SupportedAspectRatios

Defined in: src/aifreebox/aifreebox.ts:16

A specified aspect ratio for the generated image. This field is optional and allows users to define the width-to-height ratio of the image, enhancing the flexibility of presentation. If not provided, a default ratio may be applied.

slug?

optional slug: SupportedSlugs

Defined in: src/aifreebox/aifreebox.ts:17

An optional string that serves as a unique identifier for the image. This slug can be used for easier referencing or caching of the image. If not specified, the image may be assigned a default identifier.

Example

const imageParams: AIFreeboxImageParams = {
    prompt: "Generate an image of a sunset over the mountains",
    aspectRatio: "16:9",
    slug: "sunset-mountains"
};