aisbreaker-api-js - v0.1.15 / api/models/InputImage / InputImage

Interface: InputImage

api/models/InputImage.InputImage

An image message sent to the AI service.

Table of contents

Properties

• base64
• role
• url

Properties

base64

• Optional base64: string

The image, base64-encoded; either url or base64 must be set.

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/api/models/InputImage.ts:14

---

role

• role: InputImageRoleType

Role of the (input) message creator/input image. * "user": The image to edit or to respond to. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask. * "mask": An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/api/models/InputImage.ts:9

---

url

• Optional url: string

The image, url-encoded; either url or base64 must be set.

Defined in

aisbreaker-js/packages/aisbreaker-api-js/src/api/models/InputImage.ts:19