browser-use-sdk 1.2.0 → 2.0.1

package/dist/esm/api/types/DownloadUrlGenerationError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when download URL generation fails
+ */
+export interface DownloadUrlGenerationError {
+    detail?: string;
+}

package/dist/esm/api/types/DownloadUrlGenerationError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/FileView.d.mts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * View model for representing an output file generated by the agent
+ */
+export interface FileView {
+    /** Unique identifier for the output file */
+    id: string;
+    /** Name of the output file */
+    fileName: string;
+}

package/dist/esm/api/types/FileView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/HttpValidationError.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+export interface HttpValidationError {
+    detail?: BrowserUse.ValidationError[];
+}

package/dist/esm/api/types/HttpValidationError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/InsufficientCreditsError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when user has insufficient credits
+ */
+export interface InsufficientCreditsError {
+    detail?: string;
+}

package/dist/esm/api/types/InsufficientCreditsError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/InternalServerErrorBody.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response for internal server errors
+ */
+export interface InternalServerErrorBody {
+    detail?: string;
+}

package/dist/esm/api/types/InternalServerErrorBody.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/NotFoundErrorBody.d.mts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+export type NotFoundErrorBody = BrowserUse.TaskNotFoundError | BrowserUse.OutputFileNotFoundError;

package/dist/esm/api/types/NotFoundErrorBody.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/OutputFileNotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when an output file is not found
+ */
+export interface OutputFileNotFoundError {
+    detail?: string;
+}

package/dist/esm/api/types/OutputFileNotFoundError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ProfileListResponse.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * Response model for paginated profile list requests.
+ */
+export interface ProfileListResponse {
+    /** List of profile views for the current page */
+    items: BrowserUse.ProfileView[];
+    /** Total number of items in the list */
+    totalItems: number;
+    /** Page number */
+    pageNumber: number;
+    /** Number of items per page */
+    pageSize: number;
+}

package/dist/esm/api/types/ProfileListResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ProfileNotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when a profile is not found
+ */
+export interface ProfileNotFoundError {
+    detail?: string;
+}

package/dist/esm/api/types/ProfileNotFoundError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ProfileView.d.mts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * View model for representing a profile. A profile lets you preserve the login state between sessions.
+ *
+ * We recommend that you create a separate profile for each user of your app.
+ */
+export interface ProfileView {
+    /** Unique identifier for the profile */
+    id: string;
+    /** Timestamp when the profile was last used */
+    lastUsedAt?: string;
+    /** Timestamp when the profile was created */
+    createdAt: string;
+    /** Timestamp when the profile was last updated */
+    updatedAt: string;
+}

package/dist/esm/api/types/ProfileView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ProxyCountryCode.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ProxyCountryCode = "us" | "uk" | "fr" | "it" | "jp" | "au" | "de" | "fi" | "ca" | "in";
+export declare const ProxyCountryCode: {
+    readonly Us: "us";
+    readonly Uk: "uk";
+    readonly Fr: "fr";
+    readonly It: "it";
+    readonly Jp: "jp";
+    readonly Au: "au";
+    readonly De: "de";
+    readonly Fi: "fi";
+    readonly Ca: "ca";
+    readonly In: "in";
+};

package/dist/esm/api/types/ProxyCountryCode.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const ProxyCountryCode = {
+    Us: "us",
+    Uk: "uk",
+    Fr: "fr",
+    It: "it",
+    Jp: "jp",
+    Au: "au",
+    De: "de",
+    Fi: "fi",
+    Ca: "ca",
+    In: "in",
+};

package/dist/esm/api/types/SessionHasRunningTaskError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when session already has a running task
+ */
+export interface SessionHasRunningTaskError {
+    detail?: string;
+}

package/dist/esm/api/types/SessionHasRunningTaskError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionItemView.d.mts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * View model for representing a (browser) session.
+ */
+export interface SessionItemView {
+    /** Unique identifier for the session */
+    id: string;
+    /** Current status of the session (active/stopped) */
+    status: BrowserUse.SessionStatus;
+    /** URL where the browser can be viewed live in real-time */
+    liveUrl?: string;
+    /** Timestamp when the session was created and started */
+    startedAt: string;
+    /** Timestamp when the session was stopped (None if still active) */
+    finishedAt?: string;
+}

package/dist/esm/api/types/SessionItemView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionListResponse.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * Response model for paginated session list requests.
+ */
+export interface SessionListResponse {
+    /** List of session views for the current page */
+    items: BrowserUse.SessionItemView[];
+    /** Total number of items in the list */
+    totalItems: number;
+    /** Page number */
+    pageNumber: number;
+    /** Number of items per page */
+    pageSize: number;
+}

package/dist/esm/api/types/SessionListResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionNotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when a session is not found
+ */
+export interface SessionNotFoundError {
+    detail?: string;
+}

package/dist/esm/api/types/SessionNotFoundError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionStatus.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Enumeration of possible (browser) session states
+ *
+ * Attributes:
+ *     ACTIVE: Session is currently active and running (browser is running)
+ *     STOPPED: Session has been stopped and is no longer active (browser is stopped)
+ */
+export type SessionStatus = "active" | "stopped";
+export declare const SessionStatus: {
+    readonly Active: "active";
+    readonly Stopped: "stopped";
+};

package/dist/esm/api/types/SessionStatus.mjs

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const SessionStatus = {
+    Active: "active",
+    Stopped: "stopped",
+};

package/dist/esm/api/types/SessionStoppedError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when trying to use a stopped session
+ */
+export interface SessionStoppedError {
+    detail?: string;
+}

package/dist/esm/api/types/SessionStoppedError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionUpdateAction.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Available actions that can be performed on a session
+ *
+ * Attributes:
+ *     STOP: Stop the session and all its associated tasks (cannot be undone)
+ */
+export type SessionUpdateAction = "stop";

package/dist/esm/api/types/SessionUpdateAction.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SessionView.d.mts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * View model for representing a (browser) session with its associated tasks.
+ */
+export interface SessionView {
+    /** Unique identifier for the session */
+    id: string;
+    /** Current status of the session (active/stopped) */
+    status: BrowserUse.SessionStatus;
+    /** URL where the browser can be viewed live in real-time */
+    liveUrl?: string;
+    /** Timestamp when the session was created and started */
+    startedAt: string;
+    /** Timestamp when the session was stopped (None if still active) */
+    finishedAt?: string;
+    /** List of tasks associated with this session */
+    tasks: BrowserUse.TaskItemView[];
+    /** Optional URL to access the public share of the session */
+    publicShareUrl?: string;
+}

package/dist/esm/api/types/SessionView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ShareNotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when a public share is not found
+ */
+export interface ShareNotFoundError {
+    detail?: string;
+}

package/dist/esm/api/types/ShareNotFoundError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ShareView.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * View model for representing a public share of a session.
+ */
+export interface ShareView {
+    /** Token to access the public share */
+    shareToken: string;
+    /** URL to access the public share */
+    shareUrl: string;
+    /** Number of times the public share has been viewed */
+    viewCount: number;
+    /** Timestamp of the last time the public share was viewed (None if never viewed) */
+    lastViewedAt?: string;
+}

package/dist/esm/api/types/ShareView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/SupportedLlMs.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SupportedLlMs = "gpt-4.1" | "gpt-4.1-mini" | "o4-mini" | "o3" | "gemini-2.5-flash" | "gemini-2.5-pro" | "claude-sonnet-4-20250514" | "gpt-4o" | "gpt-4o-mini" | "llama-4-maverick-17b-128e-instruct" | "claude-3-7-sonnet-20250219";
+export declare const SupportedLlMs: {
+    readonly Gpt41: "gpt-4.1";
+    readonly Gpt41Mini: "gpt-4.1-mini";
+    readonly O4Mini: "o4-mini";
+    readonly O3: "o3";
+    readonly Gemini25Flash: "gemini-2.5-flash";
+    readonly Gemini25Pro: "gemini-2.5-pro";
+    readonly ClaudeSonnet420250514: "claude-sonnet-4-20250514";
+    readonly Gpt4O: "gpt-4o";
+    readonly Gpt4OMini: "gpt-4o-mini";
+    readonly Llama4Maverick17B128EInstruct: "llama-4-maverick-17b-128e-instruct";
+    readonly Claude37Sonnet20250219: "claude-3-7-sonnet-20250219";
+};

package/dist/esm/api/types/SupportedLlMs.mjs

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const SupportedLlMs = {
+    Gpt41: "gpt-4.1",
+    Gpt41Mini: "gpt-4.1-mini",
+    O4Mini: "o4-mini",
+    O3: "o3",
+    Gemini25Flash: "gemini-2.5-flash",
+    Gemini25Pro: "gemini-2.5-pro",
+    ClaudeSonnet420250514: "claude-sonnet-4-20250514",
+    Gpt4O: "gpt-4o",
+    Gpt4OMini: "gpt-4o-mini",
+    Llama4Maverick17B128EInstruct: "llama-4-maverick-17b-128e-instruct",
+    Claude37Sonnet20250219: "claude-3-7-sonnet-20250219",
+};

package/dist/esm/api/types/TaskCreatedResponse.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for creating a task
+ */
+export interface TaskCreatedResponse {
+    /** Unique identifier for the created task */
+    id: string;
+}

package/dist/esm/api/types/TaskCreatedResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskItemView.d.mts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * View model for representing a task with its execution details
+ */
+export interface TaskItemView {
+    /** Unique identifier for the task */
+    id: string;
+    /** ID of the session this task belongs to */
+    sessionId: string;
+    /** The LLM model used for this task represented as a string */
+    llm: string;
+    /** The task prompt/instruction given to the agent */
+    task: string;
+    status: BrowserUse.TaskStatus;
+    /** Naive UTC timestamp when the task was started */
+    startedAt: string;
+    /** Naive UTC timestamp when the task completed (None if still running) */
+    finishedAt?: string;
+    /** Optional additional metadata associated with the task set by the user */
+    metadata?: Record<string, unknown>;
+    /** Whether this task was created as a scheduled task */
+    isScheduled: boolean;
+    /** Final output/result of the task */
+    output?: string;
+    /** Version of browser-use used for this task (older tasks may not have this set) */
+    browserUseVersion?: string;
+    /** Whether the task was successful (self-reported by the agent) */
+    isSuccess?: boolean;
+}

package/dist/esm/api/types/TaskItemView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskListResponse.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * Response model for paginated task list requests.
+ */
+export interface TaskListResponse {
+    /** List of task views for the current page */
+    items: BrowserUse.TaskItemView[];
+    /** Total number of items in the list */
+    totalItems: number;
+    /** Page number */
+    pageNumber: number;
+    /** Number of items per page */
+    pageSize: number;
+}

package/dist/esm/api/types/TaskListResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskLogFileResponse.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for log file requests
+ */
+export interface TaskLogFileResponse {
+    /** URL to download the log file */
+    downloadUrl: string;
+}

package/dist/esm/api/types/TaskLogFileResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskNotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when a task is not found
+ */
+export interface TaskNotFoundError {
+    detail?: string;
+}

package/dist/esm/api/types/TaskNotFoundError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskOutputFileResponse.d.mts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for output file requests.
+ */
+export interface TaskOutputFileResponse {
+    /** Unique identifier for the file */
+    id: string;
+    /** Name of the file */
+    fileName: string;
+    /** URL to download the file */
+    downloadUrl: string;
+}

package/dist/esm/api/types/TaskOutputFileResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskStatus.d.mts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Enumeration of possible task execution states
+ *
+ * Attributes:
+ *     STARTED: Task has been started and is currently running.
+ *     PAUSED: Task execution has been temporarily paused (can be resumed)
+ *     FINISHED: Task has finished and the agent has completed the task.
+ *     STOPPED: Task execution has been manually stopped (cannot be resumed).
+ */
+export type TaskStatus = "started" | "paused" | "finished" | "stopped";
+export declare const TaskStatus: {
+    readonly Started: "started";
+    readonly Paused: "paused";
+    readonly Finished: "finished";
+    readonly Stopped: "stopped";
+};

package/dist/esm/api/types/TaskStatus.mjs

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const TaskStatus = {
+    Started: "started",
+    Paused: "paused",
+    Finished: "finished",
+    Stopped: "stopped",
+};