Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/browser-use/browser-use/llms.txt

Use this file to discover all available pages before exploring further.

File actions enable the agent to work with files both in the local filesystem and in web forms.

​
write_file

Write content to a file.
​
file_name
string
required
Name of the file to write.Filename rules:
  • Use only letters, numbers, underscores, hyphens, dots, parentheses
  • Spaces are auto-converted to hyphens
Supported extensions: .txt, .md, .json, .jsonl, .csv, .html, .xml, .pdf, .docx
​
content
string
required
The content to write to the file
​
append
bool
default:"False"
Whether to append to an existing file.
  • False = overwrite entire file (default)
  • True = add to end of existing file
​
trailing_newline
bool
default:"True"
Add a newline at the end of the content
​
leading_newline
bool
default:"False"
Add a newline at the beginning of the content

​
Example

from browser_use import Agent, Browser, ChatBrowserUse

agent = Agent(
    task="Extract the top 5 posts from Hacker News and save to hn_posts.csv",
    llm=ChatBrowserUse(),
    browser=Browser()
)

await agent.run()
By default, this OVERWRITES the entire file. Use append=True to add to an existing file, or use replace_file for targeted edits.
PDF files: Write content in markdown format and it will be auto-converted to PDF.Cannot write binary files: Do not attempt to save screenshots or images (.png, .jpg, .mp4) - these are handled separately.
Implementation: browser_use.tools.service:1504

​
read_file

Read the complete content of a file.
​
file_name
string
required
Name of the file to readSupported formats:
  • Text files: .txt, .md, .json, .csv, .jsonl
  • Documents: .pdf, .docx
  • Images: .jpg, .png

​
Example

from browser_use import Agent, Browser, ChatBrowserUse

agent = Agent(
    task="Read data.json and summarize the contents",
    llm=ChatBrowserUse(),
    browser=Browser(),
    available_file_paths=["./data.json"]
)

await agent.run()
Files must be:
  1. Previously written by the agent, OR
  2. Listed in available_file_paths parameter when creating the Agent
See Agent All Parameters for file configuration.
Implementation: browser_use.tools.service:1539

​
replace_file

Replace specific text within a file without rewriting the entire file.
​
file_name
string
required
Name of the file to edit
​
old_str
string
required
Text to search for and replace
​
new_str
string
required
Replacement text

​
Example

from browser_use import Agent, Browser, ChatBrowserUse

agent = Agent(
    task="Update the todo.md file and mark 'Research AI' as completed",
    llm=ChatBrowserUse(),
    browser=Browser()
)

await agent.run()
Use replace_file for:
  • Updating todo checkboxes
  • Modifying specific lines
  • Targeted edits without rewriting entire files
Implementation: browser_use.tools.service:1531

​
upload_file

Upload a file to a web form’s file input element.
​
index
int
required
Element index from browser_state pointing to a file input or nearby element
​
path
string
required
File path to upload. Must be either:
  • Previously downloaded by the browser
  • Listed in available_file_paths parameter
  • In the FileSystem directory (for remote browsers)

​
Example

from browser_use import Agent, Browser, ChatBrowserUse

agent = Agent(
    task="Go to example.com/upload and upload document.pdf",
    llm=ChatBrowserUse(),
    browser=Browser(),
    available_file_paths=["./document.pdf"]
)

await agent.run()
The agent automatically:
  • Finds nearby file input elements if the clicked element isn’t one
  • Validates file existence and size (for local browsers)
  • Searches for the closest file input if none found near the clicked element
For security, files must be explicitly allowed via available_file_paths when creating the Agent.
agent = Agent(
    task="...",
    llm=llm,
    browser=browser,
    available_file_paths=["./file1.pdf", "./file2.jpg"]
)
Implementation: browser_use.tools.service:725

​
read_long_content

Intelligently read long content to find specific information using search and LLM extraction.
​
goal
string
required
What to look for or extract from the content
​
source
string
default:"page"
What to read:
  • "page" - Current webpage
  • File path - Path to a file
​
context
string
default:""
Additional context about the task to help with search term extraction

​
Example

from browser_use import Agent, Browser, ChatBrowserUse

agent = Agent(
    task="Go to the Python documentation and find information about async/await",
    llm=ChatBrowserUse(),
    browser=Browser()
)

await agent.run()
How it works:
  1. Extracts search terms from the goal using LLM
  2. Searches content for relevant sections
  3. Returns the most relevant chunks within token limits
  4. For PDFs, scores pages by relevance and includes page 1 + top matches
Best for:
  • Long articles or documentation
  • PDFs with many pages
  • Any content where you know what you’re looking for
Implementation: browser_use.tools.service:1580