gbox-sdk
    Preparing search index...

    Interface ActionAIParams

    interface ActionAIParams {
        background?: string;
        includeScreenshot?: boolean;
        instruction: string;
        options?: GboxClient.V1.Boxes.ActionCommonOptions;
        outputFormat?: "base64" | "storageKey";
        presignedExpiresIn?: string;
        screenshotDelay?: string;
        settings?: Settings;
        stream?: boolean;
    }
    Index

    Properties

    background? includeScreenshot? instruction options? outputFormat? presignedExpiresIn? screenshotDelay? settings? stream?

    Properties

    background?: string

    The background of the UI action to perform. The purpose of background is to let the action executor to understand the context of why the instruction is given including important previous actions and observations

    includeScreenshot?: boolean

    ⚠️ DEPRECATED: Use options.screenshot.phases instead. This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

    instruction: string

    Direct instruction of the UI action to perform (e.g., 'click the login button', 'input username in the email field', 'scroll down', 'swipe left')

    options?: GboxClient.V1.Boxes.ActionCommonOptions

    Action common options

    outputFormat?: "base64" | "storageKey"

    ⚠️ DEPRECATED: Use options.screenshot.outputFormat instead. Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

    presignedExpiresIn?: string

    ⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead. Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

    Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 30m

    screenshotDelay?: string

    ⚠️ DEPRECATED: Use options.screenshot.delay instead. This field will be ignored when options.screenshot is provided.

    Delay after performing the action, before taking the final screenshot.

    Execution flow:

    1. Take screenshot before action
    2. Perform the action
    3. Wait for screenshotDelay (this parameter)
    4. Take screenshot after action

    Example: '500ms' means wait 500ms after the action before capturing the final screenshot.

    Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 500ms Maximum allowed: 30s

    settings?: Settings

    AI action settings

    stream?: boolean

    Whether to stream progress events using Server-Sent Events (SSE). When true, the API returns an event stream. When false or omitted, the API returns a normal JSON response.

    Settings

    Member Visibility

    On This Page

    Properties