v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-26811271.7 KB

Observe available actions

Identifies and returns available actions on the current page that match the given instruction.

post/v1/sessions/{id}/observe

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

instructionstring

Natural language instruction for what actions to find

frameIdstring nullable

Target frame ID for the observation

streamResponseboolean

Whether to stream the response via SSE

Example request

{
  "instruction": "Find all clickable navigation links",
  "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,
    "selector": "nav",
    "ignoreSelectors": [
      "nav",
      ".cookie-banner",
      "#sidebar-ads"
    ]
  },
  "streamResponse": true
}

Response

Default Response

successboolean required

Indicates whether the request was successful

Example response

{
  "data": {
    "result": [
      {
        "selector": "[data-testid='submit-button']",
        "description": "Click the submit button",
        "method": "click",
        "arguments": [
          "Hello World"
        ]
      }
    ]
  }
}