Skip to content

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

Variable: FileReferenceSchema

const FileReferenceSchema: ZodObject<{ filename: ZodString; id: ZodString; metadata: ZodOptional<ZodObject<{ createdAt: ZodOptional<ZodNumber>; custom: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; description: ZodOptional<ZodString>; duration: ZodOptional<ZodNumber>; height: ZodOptional<ZodNumber>; originalUrl: ZodOptional<ZodString>; prompt: ZodOptional<ZodString>; sourceModel: ZodOptional<ZodString>; tags: ZodOptional<ZodArray<ZodString, "many">>; thumbnailFileId: ZodOptional<ZodString>; width: ZodOptional<ZodNumber>; }, "strip", ZodTypeAny, { createdAt?: number; custom?: Record<string, unknown>; description?: string; duration?: number; height?: number; originalUrl?: string; prompt?: string; sourceModel?: string; tags?: string[]; thumbnailFileId?: string; width?: number; }, { createdAt?: number; custom?: Record<string, unknown>; description?: string; duration?: number; height?: number; originalUrl?: string; prompt?: string; sourceModel?: string; tags?: string[]; thumbnailFileId?: string; width?: number; }>>; mimeType: ZodString; size: ZodNumber; }, "strip", ZodTypeAny, { 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; }; mimeType: string; size: number; }, { 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; }; mimeType: string; size: number; }>

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

FileReference - Universal file reference type for FireFlow

This is the ONLY way files should be passed between nodes. Contains metadata for instant UI rendering without API calls. Actual file content is fetched on-demand during execution.

Licensed under BUSL-1.1