SessionOptions

export interface SessionOptions extends ApiSessionStartRequest {
  /** Wait in the SDK for managed authentication on start(). Defaults to true; use() always waits. */
  wait_for_authentication?: boolean;
  /** Additional server-side login attempts, from 0 to 2. Only sent with auth_ids. */
  auth_retry?: number;
  /**
   * @deprecated Remote sessions always use the supported browser launch mode.
   * Retained as a boolean so existing typed configuration still compiles.
   * `true` is discarded; `false` raises a migration error when starting.
   */
  headless?: boolean;
  /**
   * Open the live viewer in the local default browser after the session starts.
   * This is a local SDK option and is not sent to the API.
   */
  open_viewer?: boolean;
  /**
   * Default for `execute()`: throw `ActionExecutionError` when an action fails.
   * The counterpart of `raise_on_failure` on `RemoteSession`. Defaults to true.
   */
  raiseOnFailure?: boolean;
  /** Default perception type for `observe()`. Defaults to `fast`. */
  perception_type?: PerceptionType;
  /**
   * JSON cookie file: loaded into the session on `start()` when it exists and
   * appended with the session cookies on `stop()`.
   */
  cookie_file?: string;
  /** File storage to attach to the session so agents can consume uploaded files. */
  storage?: RemoteFileStorage;
}