AI Tools

Perform Web Task

Changed on

Start from a URL and perform the given task.

post/v1/tools/perform-web-task

Request

  • Base URL
    https://api.anchorbrowser.io
  • Auth
    API key in header anchor-api-key

Query parameters

sessionIdstring

An optional browser session identifier to reference an existing running browser sessions. When passed, the tool will be executed on the provided browser session.

Request body

urlstring

The URL of the webpage. If not provided, the tool will use the current page in the session.

promptstring required

The task to be autonomously completed.

agent'browser-use' | 'openai-cua' | 'gemini-computer-use' | 'anthropic-cua' | 'yutori' | 'jev'

The AI agent to use for task completion. Defaults to browser-use.

provider'openai' | 'gemini' | 'groq' | 'azure' | 'xai'

The AI provider to use for task completion.

modelstring

The specific model to use for task completion. see our models page for more information.

detect_elementsboolean

Enable element detection for better interaction accuracy. Improves the agent's ability to identify and interact with UI elements.

human_interventionboolean

Allow human intervention during task execution. When enabled, the agent can request human input for ambiguous situations.

max_stepsinteger

Maximum number of steps the agent can take to complete the task. Defaults to 200.

llm_timeoutinteger

Timeout in seconds for each LLM call made by the agent (browser-use agent only). Raise it when tasks with deep context (long histories, large pages) hit LLM call timeouts. When omitted, the agent uses its model-based defaults.

secret_valuesobject

Secret values to pass to the agent for secure credential handling. Keys and values are passed as environment variables to the agent.

highlight_elementsboolean

Whether to highlight elements during task execution for better visibility.

output_schemaobject

JSON Schema defining the expected structure of the output data.

asyncboolean

Whether to run the task asynchronously. If true, the task will be run asynchronously and the response will include a workflow ID.

Response

The result of the autonomous task.

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new anthropic-cua enum value to the request property

    • info

      added the new gemini-computer-use enum value to the request property

    • info

      added the new jev enum value to the request property

    • info

      added the new yutori enum value to the request property