Browser Use Public API v2 is one of 4 APIs that Browser Use publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Browser Automation, Skills, and Marketplace. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
44 operations
across 29 paths,
organized into 8 resource areas,
and defines 84 schemas.
It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.browser-use.com/api/v2.
The identity and technical contract details declared by the specification.
AccountNotFoundError
object
Error response when an account is not found
1 property
AccountView
object
View model for account information.
11 properties
8 required
BrowserDownloadFile
object
A single file the browser downloaded during the session.
4 properties
3 required
BrowserDownloadListResponse
object
Paginated list of browser downloads with optional presigned URLs.
3 properties
1 required
BrowserSessionItemView
object
View model for representing a browser session in list views.
13 properties
4 required
BrowserSessionListResponse
object
Response model for paginated browser session list requests.
4 properties
4 required
BrowserSessionStatus
string
Enumeration of possible browser session states Attributes: ACTIVE: Session is currently active and running (browser is running) STOPPED: Session has been stopp…
BrowserSessionUpdateAction
string
Available actions that can be performed on a browser session Attributes: STOP: Stop the browser session (cannot be undone)
BrowserSessionView
object
View model for representing a browser session.
14 properties
4 required
CannotDeleteSkillWhileGeneratingError
object
Error response when a skill cannot be deleted while it is still generating
1 property
CannotRollbackPublicSkillError
object
Error response when trying to rollback a public skill
1 property
ConcurrentSkillCreationsError
object
Error response when concurrent skill creations are attempted
1 property
CreateBrowserSessionRequest
object
Request model for creating a browser session.
9 properties
CreateSessionRequest
object
Request model for creating a session.
9 properties
CreateSkillRequest
object
Request to create a new skill via automated generation.
4 properties
2 required
CreateSkillResponse
object
Response after creating a skill.
1 property
1 required
CreateTaskRequest
object
Request model for creating a task
21 properties
1 required
CustomProxy
object
Request model for creating a custom proxy.
5 properties
2 required
DownloadUrlGenerationError
object
Error response when download URL generation fails
1 property
EnabledSkillsLimitExceededError
object
Error response when trying to enable more skills than allowed by plan
1 property
ExecuteSkillRequest
object
Request to execute a skill.
2 properties
ExecuteSkillResponse
object
Response from executing a skill.
5 properties
1 required
FileView
object
View model for representing an output file generated by the agent
2 properties
2 required
GenerationNotCancellableError
object
Error response when generation is not cancellable
1 property
HTTPValidationError
object
1 property
InsufficientCreditsError
object
Error response when there are insufficient credits
1 property
InternalServerError
object
Error response for internal server errors
1 property
MarketplaceSkillListResponse
object
Response for listing skills.
4 properties
4 required
MarketplaceSkillResponse
object
Skill information returned by the API.
16 properties
15 required
OutputFileNotFoundError
object
Error response when an output file is not found
1 property
ParameterSchema
object
Schema for a skill parameter.
6 properties
2 required
ParameterType
string
Type of a skill parameter.
PlanInfo
object
View model for plan information
5 properties
5 required
ProfileCreateRequest
object
Request model for creating a new profile.
2 properties
ProfileListResponse
object
Response model for paginated profile list requests.
4 properties
4 required
ProfileNotFoundError
object
Error response when a profile is not found
1 property
ProfileUpdateRequest
object
Request model for updating a profile.
2 properties
ProfileView
object
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 u…
7 properties
3 required
RefineSkillRequest
object
Request to refine an existing skill.
3 properties
1 required
RefineSkillResponse
object
Response after requesting skill refinement.
1 property
1 required
SessionHasRunningTaskError
object
Error response when session already has a running task
1 property
SessionItemView
object
View model for representing a (browser) session.
10 properties
5 required
SessionListResponse
object
Response model for paginated session list requests.
4 properties
4 required
SessionNotFoundError
object
Error response when a session is not found
1 property
SessionSettings
object
Session configuration for auto-created sessions. These settings only apply when no sessionid is provided.
5 properties
SessionStatus
string
Enumeration of possible agent session states Attributes: ACTIVE: Agent session is currently active and running STOPPED: Agent session has been stopped and is n…
SessionStoppedError
object
Error response when trying to use a stopped session
1 property
SessionTimeoutLimitExceededError
object
Error response when session timeout exceeds the maximum allowed limit
1 property
SessionUpdateAction
string
Available actions that can be performed on a session Attributes: STOP: Stop the session and all its associated tasks (cannot be undone)
SessionView
object
View model for representing a (browser) session with its associated tasks.
12 properties
4 required
ShareNotFoundError
object
Error response when a public share is not found
1 property
ShareView
object
View model for representing a public share of a session.
4 properties
3 required
SkillCategory
string
Skill category.
SkillExecutionListResponse
object
Response for listing skill executions.
4 properties
4 required
SkillExecutionOutputResponse
object
Response containing presigned URL for downloading execution output.
1 property
1 required
SkillExecutionView
object
View for a skill execution.
8 properties
8 required
SkillListResponse
object
Response for listing skills.
4 properties
4 required
SkillNotFinishedError
object
Error response when skill is not finished
1 property
SkillNotFoundError
object
Error response when a skill is not found
1 property
SkillResponse
object
Skill information returned by the API.
23 properties
13 required
SkillsGenerationStatus
string
Status of skill generation.
TaskCreatedResponse
object
Response model for creating a task
2 properties
2 required
TaskItemView
object
View model for representing a task with its execution details
16 properties
6 required
TaskListResponse
object
Response model for paginated task list requests.
4 properties
4 required
TaskLogFileResponse
object
Response model for log file requests
1 property
1 required
TaskNotFoundError
object
Error response when a task is not found
1 property
TaskOutputFileResponse
object
Response model for output file requests.
3 properties
3 required
TaskStatus
string
Enumeration of possible task execution states Attributes: CREATED: Task has been created but not yet started. STARTED: Task has been started and is currently r…
TaskStatusView
object
Lightweight view optimized for polling. Use GET /tasks/{id}/status for efficient polling instead of GET /tasks/{id} which loads full step details.
6 properties
2 required
TaskStepView
object
View model for representing a single step in a task's execution
8 properties
6 required
TaskUpdateAction
string
Available actions that can be performed on a task Attributes: STOP: Stop the current task execution STOPTASKANDSESSION: Stop both the task and its parent sessi…
TaskView
object
View model for representing a task with its execution details
18 properties
8 required
ThinkingLevel
string
Provider-neutral model reasoning depth.
TooManyConcurrentActiveSessionsError
object
Error response when user has too many concurrent active sessions
1 property
UnsupportedContentTypeError
object
Error response for unsupported content types
1 property
UpdateBrowserSessionRequest
object
Request model for updating browser session state.
1 property
1 required
UpdateSessionRequest
object
Request model for updating session state.
1 property
1 required
UpdateSkillRequest
object
Request to update skill metadata.
5 properties
UpdateTaskRequest
object
Request model for updating task state
1 property
1 required
UploadFilePresignedUrlResponse
object
Response model for a presigned upload URL.
5 properties
5 required
UploadFileRequest
object
Request model for uploading a file to the user's files bucket.
3 properties
3 required
ValidationError
object
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Browser Use publishes across the network.