providerplaneai
    Preparing search index...

    Interface ClientVideoGenerationRequest

    Interface contract for ClientVideoGenerationRequest.

    interface ClientVideoGenerationRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        model?: string;
        options?: Record<string, unknown>;
        params?: {
            downloadVariant?: "video" | "thumbnail" | "spritesheet";
            includeBase64?: boolean;
            maxPollMs?: number;
            model?: string;
            pollIntervalMs?: number;
            pollUntilComplete?: boolean;
            seconds?: ClientVideoGenerationSeconds;
            size?: ClientVideoGenerationSize;
        };
        prompt: string;
        referenceImage?: ClientReferenceImage;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? model? options? params? prompt referenceImage?

    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?: {
        downloadVariant?: "video" | "thumbnail" | "spritesheet";
        includeBase64?: boolean;
        maxPollMs?: number;
        model?: string;
        pollIntervalMs?: number;
        pollUntilComplete?: boolean;
        seconds?: ClientVideoGenerationSeconds;
        size?: ClientVideoGenerationSize;
    }

    Optional generation/polling controls.

    prompt: string

    Prompt used to generate the video.

    referenceImage?: ClientReferenceImage

    Optional reference image guidance for generation.

    Settings

    Member Visibility

    On This Page

    Properties