providerplaneai
    Preparing search index...

    Interface ClientImageEditRequest

    Request payload for image editing operations that transform one or more reference images.

    interface ClientImageEditRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        model?: string;
        options?: Record<string, unknown>;
        params?: {
            autoGenerateMask?: boolean;
            background?: string;
            count?: number;
            quality?: string;
            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?: {
        autoGenerateMask?: boolean;
        background?: string;
        count?: number;
        quality?: string;
        size?: string;
        style?: string;
    }

    Additional provider-agnostic generation parameters

    prompt: string

    Text prompt describing how to edit the image

    referenceImages?: ClientReferenceImage[]

    Images involved in the edit operation.

    Typical patterns:

    • reference: base image to edit
    • mask: edit mask
    • style: style transfer

    Settings

    Member Visibility

    On This Page

    Properties