providerplaneai
    Preparing search index...

    Interface ClientImageGenerationRequest

    Interface contract for ClientImageGenerationRequest.

    interface ClientImageGenerationRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        model?: string;
        options?: Record<string, unknown>;
        params?: {
            background?: "transparent" | "opaque";
            extras?: Record<string, unknown>;
            format?: "png" | "jpeg" | "webp" | "avif";
            quality?: "low" | "medium" | "high" | "ultra";
            size?: string;
            style?: string;
        };
        prompt: string;
        referenceImages?: ClientReferenceImage[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? model? options? params? prompt referenceImages?

    Properties

    context?: { metadata?: Record<string, unknown>; requestId?: string }

    Execution context (tracing, requestId, etc.) Not sent to the provider.

    model?: string
    options?: Record<string, unknown>

    Provider-agnostic tuning options (temperature, max tokens, etc.)

    params?: {
        background?: "transparent" | "opaque";
        extras?: Record<string, unknown>;
        format?: "png" | "jpeg" | "webp" | "avif";
        quality?: "low" | "medium" | "high" | "ultra";
        size?: string;
        style?: string;
    }

    Additional provider-agnostic generation parameters

    prompt: string

    Text prompt describing the desired image

    referenceImages?: ClientReferenceImage[]

    Optional reference images to guide generation

    Settings

    Member Visibility

    On This Page

    Properties