Sign in
AI Tools

Perform Web Task

Start from a URL and perform the given task.

post/v1/tools/perform-web-task

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'

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.

highlight_elementsboolean

Whether to highlight elements during task execution for better visibility.

output_schemaobject

JSON Schema defining the expected structure of the output data.

Response

The result of the autonomous task.

Changes