v1

latestOpenAPI 3.1.02026-07-138112134.9 KB

Perform an action

Executes a browser action using natural language instructions or a predefined Action object.

post/v1/sessions/{id}/act

Path parameters

idstring required

Unique session identifier

Example:c4dbf3a9-9a58-4b22-8a1c-9f20f9f9e123

Unique session identifier

Headers

x-stream-response'true' | 'false'

Whether to stream the response via SSE

Example:true

Whether to stream the response via SSE

Request body

frameIdstring nullable

Target frame ID for the action

streamResponseboolean

Whether to stream the response via SSE

Example request

{
  "input": {
    "selector": "[data-testid='submit-button']",
    "description": "Click the submit button",
    "method": "click",
    "arguments": [
      "Hello World"
    ]
  },
  "options": {
    "model": {
      "modelName": "openai/gpt-5.4-mini",
      "apiKey": "sk-some-openai-api-key",
      "baseURL": "https://api.openai.com/v1",
      "providerOptions": {
        "vertex": {
          "project": "my-gcp-project",
          "location": "us-central1"
        }
      }
    },
    "timeout": 30000
  },
  "streamResponse": true
}

Response

Default Response

successboolean required

Indicates whether the request was successful

Example response

{
  "data": {
    "result": {
      "success": true,
      "message": "Successfully clicked the login button",
      "actionDescription": "Clicked button with text 'Login'",
      "actions": [
        {
          "selector": "[data-testid='submit-button']",
          "description": "Click the submit button",
          "method": "click",
          "arguments": [
            "Hello World"
          ]
        }
      ]
    }
  }
}

All 8 operations