JavaScript

import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const task = await client.tasks.create({ task: 'x' });

console.log(task.id);

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Tasks

Create Task

Create and start a new Browser Use Agent task.

This is the main endpoint for running AI agents. You can either:

Start a new session with a new task.
Add a follow-up task to an existing session.

When starting a new session:

A new browser session is created
Credits are deducted from your account
The agent begins executing your task immediately

When adding to an existing session:

The agent continues in the same browser context
No additional browser start up costs are charged (browser session is already active)
The agent can build on previous work

Key features:

Agent profiles: Define agent behavior and capabilities
Browser profiles: Control browser settings and environment (only used for new sessions)
File uploads: Include documents for the agent to work with
Structured output: Define the format of the task result
Task metadata: Add custom data for tracking and organization

Args:

request: Complete task configuration including agent settings, browser settings, and task description

Returns:

The created task ID together with the task’s session ID

Raises:

402: If user has insufficient credits for a new session
404: If referenced agent/browser profiles don’t exist
400: If session is stopped or already has a running task

POST

tasks

JavaScript

import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const task = await client.tasks.create({ task: 'x' });

console.log(task.id);

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-Browser-Use-API-Key

string

header

required

Body

application/json

Request model for creating a new task

Attributes: task: The task prompt/instruction for the agent agent_settings: Agent configuration (optional) browser_settings: Browser configuration (optional) included_file_names: Optional list of file names to include in the task (file names from user file presigned upload URL response) structured_output_json: JSON schema for structured output (optional) metadata: Additional metadata associated with the task (optionally set by the user) secrets: Sensitive data (passwords, tokens) for the session (deleted after session is stopped)

Response

202

application/json

Successful Response

Response model for creating a task

Attributes: task_id: An unique identifier for the created task session_id: The ID of the session this task belongs to

List Tasks

Get Task

Get Started

Platform

REST API reference

Create Task

Authorizations

Body

Response