PersistentAI API Documentation / @persistentai/fireflow-types / createImageFileReference

Function: createImageFileReference()

createImageFileReference(data): object

Defined in: packages/fireflow-types/src/file/file-reference.ts:118

Parameters

data

filename

string

height

number

id

string

mimeType

string

prompt?

string

size

number

sourceModel?

string

width

number

Returns

filename

filename: string

Original or generated filename with extension

id

id: string

Unique file identifier (FI prefix + 20 chars)

metadata?

optional metadata: object

Optional extended metadata

metadata.createdAt?

optional createdAt: number

metadata.custom?

optional custom: Record<string, unknown>

metadata.description?

optional description: string

metadata.duration?

optional duration: number

metadata.height?

optional height: number

metadata.originalUrl?

optional originalUrl: string

metadata.prompt?

optional prompt: string

metadata.sourceModel?

optional sourceModel: string

metadata.tags?

optional tags: string[]

metadata.thumbnailFileId?

optional thumbnailFileId: string

metadata.width?

optional width: number

mimeType

mimeType: string

MIME type (e.g., "image/png", "application/pdf")

size

size: number

File size in bytes