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

Function: createFileReference()

createFileReference(data): object

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

Parameters

data

filename

string

id

string

metadata?

{ createdAt?: number; custom?: Record<string, unknown>; description?: string; duration?: number; height?: number; originalUrl?: string; prompt?: string; sourceModel?: string; tags?: string[]; thumbnailFileId?: string; width?: number; }

metadata.createdAt?

number = ...

metadata.custom?

Record<string, unknown> = ...

metadata.description?

string = ...

metadata.duration?

number = ...

metadata.height?

number = ...

metadata.originalUrl?

string = ...

metadata.prompt?

string = ...

metadata.sourceModel?

string = ...

metadata.tags?

string[] = ...

metadata.thumbnailFileId?

string = ...

metadata.width?

number = ...

mimeType

string

size

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