Browser Use Dify Plugin

Author: lysonober
Version: 0.0.1
Type: tool

Description

The Browser Use Dify Plugin provides a comprehensive integration between Dify AI agents and the Browser Use platform, enabling AI agents to control and interact with web browsers. This plugin allows AI agents to automate web tasks, retrieve browser session data, and manage browser automation workflows through a simple and consistent interface.

Available Tools

Tool Name	Description	Use Case Scenario
ping	Checks server connection status to verify API availability	An AI agent needs to verify if the Browser Use service is operational before attempting to run web automation tasks
me	Validates API key and returns user information	Before starting a session, an agent verifies that the provided API credentials are valid and have the necessary permissions
check_balance	Retrieves user's API credit balance	A user wants to know how many credits they have remaining before running a potentially expensive automation task
run_task	Creates and runs browser automation tasks	A marketing team uses an AI agent to automate competitor research by having it visit multiple websites and extract pricing information
get_task_status	Retrieves current status of a specific task	A user wants to check if their web scraping task has completed without viewing the full details
get_task	Retrieves comprehensive task details	After a task completes, a user needs to analyze the full output, including any errors or extracted data
stop_task	Permanently stops a running task	A user notices their automation is visiting incorrect websites and wants to immediately terminate the process
list_tasks	Lists all tasks with pagination support	A team manager wants to review all automation tasks run in the past week to analyze usage patterns
pause_task	Temporarily pauses a running task	During a complex form-filling process, a user wants to pause the automation to manually verify some information before continuing
resume_task	Resumes a previously paused task	After reviewing the paused automation state, the user is ready to continue the process from where it left off
get_task_media	Retrieves media recordings from a task	A QA team wants to review the visual recording of an automated test to understand why a specific step failed
get_task_gif	Gets an animated GIF of the task execution	A user wants to share a quick visual demonstration of their automation with colleagues without sharing the full recording

Response Format

All tools in this plugin support two types of responses:

1. JSON Response

   • Contains complete structured information
   • Maintains backward compatibility with existing integrations
   • Includes all detailed information about the task or operation

2. Text Response

   • Provides quick access to key information
   • Added for easier parameter passing and quick information retrieval
   • Only available when relevant information exists

Text Response Availability

• get_task: Outputs task result when available
• run_task: Outputs task ID
• get_task_status: Outputs task status
• check_balance: Outputs balance value
• get_task_media: Outputs recording URL when recordings exist

Tool Documentation

pingService

Checks the Browser Use API server connection status.

Parameters:

None required

Response:

{
  "status": "success",
  "message": "Browser Use API server is running and responding",
  "response": {
    "message": "Pong!"
  }
}

getUserInfo

Validates the API key and returns user account information.

Parameters:

None required

Response:

{
  "status": "success",
  "is_valid": true,
  "message": "API key is valid and authenticated"
}

check_balance

Retrieves the current credit balance for the user's account.

Parameters:

None required

Response:

{
  "status": "success",
  "balance": 3000,
  "balance_usd": 30.00,
  "message": "Your current balance is 3000 credits ($30.00 USD)"
}

run_task

Creates and executes a browser automation task based on natural language instructions.

Parameters:

Parameter	Type	Required	Description
task	string	Yes	Natural language description of the task to perform
save_browser_data	boolean	No	Whether to save browser session data for future tasks (default: false)

Success Response:

{
  "status": "success",
  "message": "Task created successfully",
  "task_id": "task_12345",
  "task_info": {
    "status": "created",
    "created_at": "2025-04-13T20:15:30Z",
    "live_url": "https://live.browser-use.com/task_12345"
  }
}

Error Response:

{
  "status": "error",
  "message": "Failed to create task: Invalid task description"
}

get_task_status

Retrieves the current status of a specific task.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task

Response:

{
  "status": "success",
  "message": "Task status: Task is currently running",
  "task_status": "running"
}

get_task

Retrieves comprehensive details about a specific task.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task

Response:

{
  "status": "success",
  "message": "Task 'Research educational programs...' is currently running. A live preview URL is available.",
  "task_details": {
    "created_at": "2025-04-13T20:10:35Z",
    "finished_at": null,
    "has_browser_data": false,
    "id": "abc123de-4567-8f90-gh12-3456789ijklm",
    "live_url": "https://live.example.com?sessionId=xyz987ab-6543-21cd-ef09-8765432hgfds",
    "output": null,
    "status": "running",
    "steps_count": 20,
    "task": "Research educational programs..."
  }
}

stop_task

Permanently stops a running task. The task cannot be resumed after stopping.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task to stop

list_tasks

Returns a paginated list of all tasks belonging to the user, ordered by creation date.

Parameters:

Parameter	Type	Required	Description
page	number	No	The page number to retrieve (default: 1)
limit	number	No	The number of tasks per page (default: 10)

Response:

{
  "status": "success",
  "message": "Found 1 tasks. Showing page 1 of 1 (1 tasks per page).",
  "pagination": {
    "current_page": 1,
    "tasks_per_page": 1,
    "total_pages": 1,
    "total_tasks": 1
  },
  "tasks": [
    {
      "created_at": "2025-04-13T20:10:35Z",
      "description": "Research educational programs...",
      "id": "abc123de-4567-8f90-gh12-3456789ijklm",
      "status": "running"
    }
  ]
}

pause_task

Temporarily pauses execution of a running task. The task can be resumed later.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task to pause

resume_task

Resumes execution of a previously paused task. Cannot resume stopped tasks.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the paused task to resume

get_task_media

Retrieves links to recordings or media generated during task execution.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task

get_task_gif

Returns a GIF URL generated from the screenshots of the task execution.

Parameters:

Parameter	Type	Required	Description
task_id	string	Yes	The unique identifier of the task

Additional Tools

The following tools are also available in this plugin. Please explore them to discover their full capabilities:

• stop_task
• pause_task
• resume_task
• get_task_media
• get_task_gif

Support

If you have any questions, please contact me at: lysonober@gmail.com

Follow me on X (Twitter): https://x.com/lyson_ober