providerplaneai
    Preparing search index...

    Interface ClientReferenceImage

    Describes a reference image supplied by URL, inline base64, or a provider-native handle.

    interface ClientReferenceImage {
        base64?: string;
        description?: string;
        extras?: Record<string, unknown>;
        id: string;
        mimeType?: string;
        role?: "reference" | "mask" | "control" | "subject" | "style";
        sourceType: "provider" | "url" | "base64";
        url?: string;
        weight?: number;
    }
    Index

    Properties

    base64? description? extras? id mimeType? role? sourceType url? weight?

    Properties

    base64?: string

    Raw base64 data (no data: prefix)

    description?: string
    extras?: Record<string, unknown>

    Provider escape hatch

    id: string
    mimeType?: string

    Required when base64 is used

    role?: "reference" | "mask" | "control" | "subject" | "style"

    Optional semantic role

    sourceType: "provider" | "url" | "base64"
    url?: string

    Public or signed URL

    weight?: number

    Optional strength/weight hint (0–1)

    Settings

    Member Visibility

    On This Page

    Properties