Skip to main content
POST
Instruct

Description

Issues a natural language instruction to the browser. AI interprets the instruction and performs the necessary interactions, such as clicking, typing, navigating, and extracting content.

Authentication

Open-source deployments do not require authentication by default. If your server config enables X-API-Key, include that header with the request.

Path Parameters

id
string
required
The browser ID returned from Create Session.

Request Body

instruction
string
required
A natural language description of what the browser should do.

Response

success
boolean
Whether the instruction was completed successfully.
data
object
Result of the instruction. Structure depends on the instruction and configured AI provider.

Example