Skip to content
This repository was archived by the owner on Feb 25, 2026. It is now read-only.

reference.md

Latest commit

 

History

History
2771 lines (1924 loc) · 31.2 KB

reference.md

File metadata and controls

2771 lines (1924 loc) · 31.2 KB

Reference

Billing

client.billing.getAccountBilling() -> BrowserUse.AccountView

📝 Description

Get authenticated account information including credit balance and account details.

🔌 Usage

await client.billing.getAccountBilling();

⚙️ Parameters

requestOptions: Billing.RequestOptions

Tasks

client.tasks.listTasks({ ...params }) -> BrowserUse.TaskListResponse

📝 Description

Get paginated list of AI agent tasks with optional filtering by session and status.

🔌 Usage

await client.tasks.listTasks();

⚙️ Parameters

request: BrowserUse.ListTasksTasksGetRequest

requestOptions: Tasks.RequestOptions

client.tasks.createTask({ ...params }) -> BrowserUse.TaskCreatedResponse

📝 Description

Create and start a new task.

You can either:

  1. Start a new task without a sessionId (auto-creates a session with US proxy by default). Note: Tasks without a sessionId are one-off tasks that automatically close the session upon completion (keep_alive=false).
  2. Start a new task in an existing session (reuse for follow-up tasks or custom configuration)

Important: Proxy configuration (proxyCountryCode) and other session settings (like keep_alive) are session-level settings, not task-level settings. For full control over session configuration, create a session first via POST /sessions with your desired settings, then pass that sessionId when creating tasks.

🔌 Usage

await client.tasks.createTask({
    task: "task"
});

⚙️ Parameters

request: BrowserUse.CreateTaskRequest

requestOptions: Tasks.RequestOptions

client.tasks.getTask({ ...params }) -> BrowserUse.TaskView

📝 Description

Get detailed task information including status, progress, steps, and file outputs.

🔌 Usage

await client.tasks.getTask({
    task_id: "task_id"
});

⚙️ Parameters

request: BrowserUse.GetTaskTasksTaskIdGetRequest

requestOptions: Tasks.RequestOptions

client.tasks.updateTask({ ...params }) -> BrowserUse.TaskView

📝 Description

Control task execution with stop, pause, resume, or stop task and session actions.

🔌 Usage

await client.tasks.updateTask({
    task_id: "task_id",
    action: "stop"
});

⚙️ Parameters

request: BrowserUse.UpdateTaskRequest

requestOptions: Tasks.RequestOptions

client.tasks.getTaskStatus({ ...params }) -> BrowserUse.TaskStatusView

📝 Description

Lightweight endpoint optimized for polling task status.

Returns only the task status, output, and cost without loading steps, files, or session details. Use this endpoint for efficient polling instead of GET /tasks/{task_id}.

Recommended polling pattern:

  1. POST /tasks to create a task
  2. Poll GET /tasks/{task_id}/status until status is 'finished' or 'stopped'
  3. GET /tasks/{task_id} once at the end for full details including steps

🔌 Usage

await client.tasks.getTaskStatus({
    task_id: "task_id"
});

⚙️ Parameters

request: BrowserUse.GetTaskStatusTasksTaskIdStatusGetRequest

requestOptions: Tasks.RequestOptions

client.tasks.getTaskLogs({ ...params }) -> BrowserUse.TaskLogFileResponse

📝 Description

Get secure download URL for task execution logs with step-by-step details.

🔌 Usage

await client.tasks.getTaskLogs({
    task_id: "task_id"
});

⚙️ Parameters

request: BrowserUse.GetTaskLogsTasksTaskIdLogsGetRequest

requestOptions: Tasks.RequestOptions

Sessions

client.sessions.listSessions({ ...params }) -> BrowserUse.SessionListResponse

📝 Description

Get paginated list of AI agent sessions with optional status filtering.

🔌 Usage

await client.sessions.listSessions();

⚙️ Parameters

request: BrowserUse.ListSessionsSessionsGetRequest

requestOptions: Sessions.RequestOptions

client.sessions.createSession({ ...params }) -> BrowserUse.SessionItemView

📝 Description

Create a new session with a new task.

🔌 Usage

await client.sessions.createSession();

⚙️ Parameters

request: BrowserUse.CreateSessionRequest

requestOptions: Sessions.RequestOptions

client.sessions.getSession({ ...params }) -> BrowserUse.SessionView

📝 Description

Get detailed session information including status, URLs, and task details.

🔌 Usage

await client.sessions.getSession({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.GetSessionSessionsSessionIdGetRequest

requestOptions: Sessions.RequestOptions

client.sessions.deleteSession({ ...params }) -> void

📝 Description

Delete a session with all its tasks.

🔌 Usage

await client.sessions.deleteSession({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.DeleteSessionSessionsSessionIdDeleteRequest

requestOptions: Sessions.RequestOptions

client.sessions.updateSession({ ...params }) -> BrowserUse.SessionView

📝 Description

Stop a session and all its running tasks.

🔌 Usage

await client.sessions.updateSession({
    session_id: "session_id",
    action: "stop"
});

⚙️ Parameters

request: BrowserUse.UpdateSessionRequest

requestOptions: Sessions.RequestOptions

client.sessions.getSessionPublicShare({ ...params }) -> BrowserUse.ShareView

📝 Description

Get public share information including URL and usage statistics.

🔌 Usage

await client.sessions.getSessionPublicShare({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.GetSessionPublicShareSessionsSessionIdPublicShareGetRequest

requestOptions: Sessions.RequestOptions

client.sessions.createSessionPublicShare({ ...params }) -> BrowserUse.ShareView

📝 Description

Create or return existing public share for a session.

🔌 Usage

await client.sessions.createSessionPublicShare({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.CreateSessionPublicShareSessionsSessionIdPublicSharePostRequest

requestOptions: Sessions.RequestOptions

client.sessions.deleteSessionPublicShare({ ...params }) -> void

📝 Description

Remove public share for a session.

🔌 Usage

await client.sessions.deleteSessionPublicShare({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.DeleteSessionPublicShareSessionsSessionIdPublicShareDeleteRequest

requestOptions: Sessions.RequestOptions

Files

client.files.agentSessionUploadFilePresignedUrl({ ...params }) -> BrowserUse.UploadFilePresignedUrlResponse

📝 Description

Generate a secure presigned URL for uploading files to an agent session.

🔌 Usage

await client.files.agentSessionUploadFilePresignedUrl({
    session_id: "session_id",
    body: {
        fileName: "fileName",
        contentType: "image/jpg",
        sizeBytes: 1
    }
});

⚙️ Parameters

request: BrowserUse.AgentSessionUploadFilePresignedUrlFilesSessionsSessionIdPresignedUrlPostRequest

requestOptions: Files.RequestOptions

client.files.browserSessionUploadFilePresignedUrl({ ...params }) -> BrowserUse.UploadFilePresignedUrlResponse

📝 Description

Generate a secure presigned URL for uploading files to a browser session.

🔌 Usage

await client.files.browserSessionUploadFilePresignedUrl({
    session_id: "session_id",
    body: {
        fileName: "fileName",
        contentType: "image/jpg",
        sizeBytes: 1
    }
});

⚙️ Parameters

request: BrowserUse.BrowserSessionUploadFilePresignedUrlFilesBrowsersSessionIdPresignedUrlPostRequest

requestOptions: Files.RequestOptions

client.files.getTaskOutputFilePresignedUrl({ ...params }) -> BrowserUse.TaskOutputFileResponse

📝 Description

Get secure download URL for an output file generated by the AI agent.

🔌 Usage

await client.files.getTaskOutputFilePresignedUrl({
    task_id: "task_id",
    file_id: "file_id"
});

⚙️ Parameters

request: BrowserUse.GetTaskOutputFilePresignedUrlFilesTasksTaskIdOutputFilesFileIdGetRequest

requestOptions: Files.RequestOptions

Profiles

client.profiles.listProfiles({ ...params }) -> BrowserUse.ProfileListResponse

📝 Description

Get paginated list of profiles.

🔌 Usage

await client.profiles.listProfiles();

⚙️ Parameters

request: BrowserUse.ListProfilesProfilesGetRequest

requestOptions: Profiles.RequestOptions

client.profiles.createProfile({ ...params }) -> BrowserUse.ProfileView

📝 Description

Profiles allow you to preserve the state of the browser between tasks.

They are most commonly used to allow users to preserve the log-in state in the agent between tasks. You'd normally create one profile per user and then use it for all their tasks.

You can create a new profile by calling this endpoint.

🔌 Usage

await client.profiles.createProfile();

⚙️ Parameters

request: BrowserUse.ProfileCreateRequest

requestOptions: Profiles.RequestOptions

client.profiles.getProfile({ ...params }) -> BrowserUse.ProfileView

📝 Description

Get profile details.

🔌 Usage

await client.profiles.getProfile({
    profile_id: "profile_id"
});

⚙️ Parameters

request: BrowserUse.GetProfileProfilesProfileIdGetRequest

requestOptions: Profiles.RequestOptions

client.profiles.deleteBrowserProfile({ ...params }) -> void

📝 Description

Permanently delete a browser profile and its configuration.

🔌 Usage

await client.profiles.deleteBrowserProfile({
    profile_id: "profile_id"
});

⚙️ Parameters

request: BrowserUse.DeleteBrowserProfileProfilesProfileIdDeleteRequest

requestOptions: Profiles.RequestOptions

client.profiles.updateProfile({ ...params }) -> BrowserUse.ProfileView

📝 Description

Update a browser profile's information.

🔌 Usage

await client.profiles.updateProfile({
    profile_id: "profile_id"
});

⚙️ Parameters

request: BrowserUse.ProfileUpdateRequest

requestOptions: Profiles.RequestOptions

Browsers

client.browsers.listBrowserSessions({ ...params }) -> BrowserUse.BrowserSessionListResponse

📝 Description

Get paginated list of browser sessions with optional status filtering.

🔌 Usage

await client.browsers.listBrowserSessions();

⚙️ Parameters

request: BrowserUse.ListBrowserSessionsBrowsersGetRequest

requestOptions: Browsers.RequestOptions

client.browsers.createBrowserSession({ ...params }) -> BrowserUse.BrowserSessionItemView

📝 Description

Create a new browser session.

Pricing: Browser sessions are charged per hour with tiered pricing:

  • Pay As You Go users: $0.06/hour
  • Business/Scaleup subscribers: $0.03/hour (50% discount)

The full rate is charged upfront when the session starts. When you stop the session, any unused time is automatically refunded proportionally.

Billing is rounded up to the minute (minimum 1 minute). For example, if you stop a session after 30 minutes, you'll be refunded half the charged amount.

Session Limits:

  • All users: Up to 4 hours per session

🔌 Usage

await client.browsers.createBrowserSession();

⚙️ Parameters

request: BrowserUse.CreateBrowserSessionRequest

requestOptions: Browsers.RequestOptions

client.browsers.getBrowserSession({ ...params }) -> BrowserUse.BrowserSessionView

📝 Description

Get detailed browser session information including status and URLs.

🔌 Usage

await client.browsers.getBrowserSession({
    session_id: "session_id"
});

⚙️ Parameters

request: BrowserUse.GetBrowserSessionBrowsersSessionIdGetRequest

requestOptions: Browsers.RequestOptions

client.browsers.updateBrowserSession({ ...params }) -> BrowserUse.BrowserSessionView

📝 Description

Stop a browser session.

Refund: When you stop a session, unused time is automatically refunded. If the session ran for less than 1 hour, you'll receive a proportional refund. Billing is ceil to the nearest minute (minimum 1 minute).

🔌 Usage

await client.browsers.updateBrowserSession({
    session_id: "session_id",
    action: "stop"
});

⚙️ Parameters

request: BrowserUse.UpdateBrowserSessionRequest

requestOptions: Browsers.RequestOptions

Skills

client.skills.listSkills({ ...params }) -> BrowserUse.SkillListResponse

📝 Description

List all skills owned by the authenticated project with optional filtering.

🔌 Usage

await client.skills.listSkills();

⚙️ Parameters

request: BrowserUse.ListSkillsSkillsGetRequest

requestOptions: Skills.RequestOptions

client.skills.createSkill({ ...params }) -> BrowserUse.CreateSkillResponse

📝 Description

Create a new skill via automated generation.

🔌 Usage

await client.skills.createSkill({
    goal: "goal",
    agentPrompt: "agentPrompt"
});

⚙️ Parameters

request: BrowserUse.CreateSkillRequest

requestOptions: Skills.RequestOptions

client.skills.getSkill({ ...params }) -> BrowserUse.SkillResponse

📝 Description

Get details of a specific skill owned by the project.

🔌 Usage

await client.skills.getSkill({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.GetSkillSkillsSkillIdGetRequest

requestOptions: Skills.RequestOptions

client.skills.deleteSkill({ ...params }) -> void

📝 Description

Delete a skill owned by the project.

🔌 Usage

await client.skills.deleteSkill({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.DeleteSkillSkillsSkillIdDeleteRequest

requestOptions: Skills.RequestOptions

client.skills.updateSkill({ ...params }) -> BrowserUse.SkillResponse

📝 Description

Update skill metadata (name, description, enabled, etc.).

🔌 Usage

await client.skills.updateSkill({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.UpdateSkillRequest

requestOptions: Skills.RequestOptions

client.skills.cancelGeneration({ ...params }) -> BrowserUse.SkillResponse

📝 Description

Cancel the current in-progress generation for a skill.

🔌 Usage

await client.skills.cancelGeneration({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.CancelGenerationSkillsSkillIdCancelPostRequest

requestOptions: Skills.RequestOptions

client.skills.rollbackSkill({ ...params }) -> BrowserUse.SkillResponse

📝 Description

Rollback to the previous version (cannot be undone).

🔌 Usage

await client.skills.rollbackSkill({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.RollbackSkillSkillsSkillIdRollbackPostRequest

requestOptions: Skills.RequestOptions

client.skills.executeSkill({ ...params }) -> BrowserUse.ExecuteSkillResponse

📝 Description

Execute a skill with the provided parameters.

🔌 Usage

await client.skills.executeSkill({
    skill_id: "skill_id",
    body: {}
});

⚙️ Parameters

request: BrowserUse.ExecuteSkillSkillsSkillIdExecutePostRequest

requestOptions: Skills.RequestOptions

client.skills.refineSkill({ ...params }) -> BrowserUse.RefineSkillResponse

📝 Description

Refine a skill based on feedback.

🔌 Usage

await client.skills.refineSkill({
    skill_id: "skill_id",
    feedback: "feedback"
});

⚙️ Parameters

request: BrowserUse.RefineSkillRequest

requestOptions: Skills.RequestOptions

client.skills.listSkillExecutions({ ...params }) -> BrowserUse.SkillExecutionListResponse

📝 Description

List executions for a specific skill.

🔌 Usage

await client.skills.listSkillExecutions({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.ListSkillExecutionsSkillsSkillIdExecutionsGetRequest

requestOptions: Skills.RequestOptions

client.skills.getSkillExecutionOutput({ ...params }) -> BrowserUse.SkillExecutionOutputResponse

📝 Description

Get presigned URL for downloading skill execution output.

🔌 Usage

await client.skills.getSkillExecutionOutput({
    skill_id: "skill_id",
    execution_id: "execution_id"
});

⚙️ Parameters

request: BrowserUse.GetSkillExecutionOutputSkillsSkillIdExecutionsExecutionIdOutputGetRequest

requestOptions: Skills.RequestOptions

SkillsMarketplace

client.skillsMarketplace.listSkills({ ...params }) -> BrowserUse.MarketplaceSkillListResponse

📝 Description

List all public skills available in the marketplace with optional filtering.

🔌 Usage

await client.skillsMarketplace.listSkills();

⚙️ Parameters

request: BrowserUse.ListSkillsMarketplaceSkillsGetRequest

requestOptions: SkillsMarketplace.RequestOptions

client.skillsMarketplace.getSkill({ ...params }) -> BrowserUse.MarketplaceSkillResponse

📝 Description

Get details of a specific public skill from the marketplace.

🔌 Usage

await client.skillsMarketplace.getSkill({
    skill_slug: "skill_slug"
});

⚙️ Parameters

request: BrowserUse.GetSkillMarketplaceSkillsSkillSlugGetRequest

requestOptions: SkillsMarketplace.RequestOptions

client.skillsMarketplace.cloneSkill({ ...params }) -> BrowserUse.SkillResponse

📝 Description

Clone a public marketplace skill to the user's project.

🔌 Usage

await client.skillsMarketplace.cloneSkill({
    skill_id: "skill_id"
});

⚙️ Parameters

request: BrowserUse.CloneSkillMarketplaceSkillsSkillIdClonePostRequest

requestOptions: SkillsMarketplace.RequestOptions

client.skillsMarketplace.executeSkill({ ...params }) -> BrowserUse.ExecuteSkillResponse

📝 Description

Execute a skill with the provided parameters.

🔌 Usage

await client.skillsMarketplace.executeSkill({
    skill_id: "skill_id",
    body: {}
});

⚙️ Parameters

request: BrowserUse.ExecuteSkillMarketplaceSkillsSkillIdExecutePostRequest

requestOptions: SkillsMarketplace.RequestOptions