Skip to main content

​
Authentication

All endpoints require an API key via the x-api-key header. Get your key at cloud.browser-use.com/settings, or set it as BROWSER_USE_API_KEY in your environment.

​
API Versions

BU Agent API (v3)

Recommended for new projects. Session-based agent API with simplified resource model.Base URL: https://api.browser-use.com/api/v3Resources: Sessions, Messages, Files, Workspaces
  • Create sessions with optional tasks
  • Structured output via JSON Schema
  • File upload/download per session
  • Persistent workspaces across sessions
  • Models: bu-mini (default) and bu-max

Cloud API v2 (Stable)

Full-featured stable API. Task-based with extended resources.Base URL: https://api.browser-use.com/api/v2Resources: Tasks, Sessions, Profiles, Browsers, Skills, Marketplace, Billing
  • Run tasks with streaming step logs
  • Browser profiles for persistent state
  • Direct CDP browser access
  • Skills: turn websites into API endpoints
  • Skill marketplace

​
SDKs

Both APIs ship in a single package. Install once, import by version. 
npm install browser-use-sdk

import { BrowserUse } from "browser-use-sdk/v3";

const client = new BrowserUse();
const result = await client.run("Find the top HN post");
console.log(result.output);

​
Endpoint Overview

​
BU Agent API (v3)

MethodPathDescription
POST/sessionsCreate a session and/or dispatch a task
GET/sessionsList sessions
GET/sessions/{id}Get session details
DELETE/sessions/{id}Delete a session
POST/sessions/{id}/stopStop a session or its running task
GET/sessions/{id}/messagesGet session message history
GET/sessions/{id}/filesList files in session workspace
POST/sessions/{id}/files/uploadGet presigned upload URLs
POST/workspacesCreate a persistent workspace
GET/workspacesList workspaces
GET/workspaces/{id}Get workspace details
PATCH/workspaces/{id}Update workspace metadata
DELETE/workspaces/{id}Delete a workspace
GET/workspaces/{id}/filesList workspace files
GET/workspaces/{id}/sizeGet workspace storage usage
POST/workspaces/{id}/files/uploadUpload files to workspace

​
Cloud API v2 (Stable)

MethodPathDescription
GET/billing/accountGet account info and credit balance
GET/tasksList tasks
POST/tasksCreate and run a task
GET/tasks/{id}Get task details
GET/tasks/{id}/statusPoll task status
GET/tasks/{id}/logsGet task step logs
GET/sessionsList sessions
POST/sessionsCreate a session
GET/sessions/{id}Get session details
POST/sessions/{id}/purgePurge session data
GET/profilesList browser profiles
POST/profilesCreate a browser profile
GET/profiles/{id}Get profile details
DELETE/profiles/{id}Delete a profile
POST/browsersCreate a CDP browser
GET/browsers/{id}Get browser details
POST/skillsCreate a skill
GET/skillsList skills
GET/skills/{id}Get skill details
POST/skills/{id}/executeExecute a skill
POST/skills/{id}/refineRefine a skill
POST/skills/{id}/cancelCancel skill training
POST/skills/{id}/rollbackRollback skill version
GET/skills/{id}/executionsList skill executions
GET/skills/{id}/executions/{eid}/outputGet execution output
GET/marketplace/skillsBrowse marketplace skills
GET/marketplace/skills/{slug}Get marketplace skill
POST/marketplace/skills/{id}/cloneClone a marketplace skill
POST/marketplace/skills/{id}/executeExecute a marketplace skill