POST
/
sessions
/
{session_id}
/
page
/
observe
{
  "metadata": {
    "title": "<string>",
    "url": "<string>",
    "viewport": {
      "scroll_x": 123,
      "scroll_y": 123,
      "viewport_width": 123,
      "viewport_height": 123,
      "total_width": 123,
      "total_height": 123
    },
    "tabs": [
      {
        "tab_id": 123,
        "title": "<string>",
        "url": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "screenshot": {
    "bboxes": [
      {
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123,
        "scroll_x": 123,
        "scroll_y": 123,
        "iframe_offset_x": 0,
        "iframe_offset_y": 0,
        "viewport_width": 123,
        "viewport_height": 123,
        "notte_id": "<string>"
      }
    ],
    "last_action_id": "<string>"
  },
  "space": {
    "description": "<string>",
    "interaction_actions": [
      {
        "type": "click",
        "category": "Interaction Actions",
        "description": "Click on an element of the current page",
        "id": "<string>",
        "selector": {
          "css_selector": "<string>",
          "xpath_selector": "<string>",
          "notte_selector": "<string>",
          "in_iframe": true,
          "in_shadow_root": true,
          "iframe_parent_css_selectors": [
            "<string>"
          ],
          "playwright_selector": "<string>",
          "python_selector": "<string>"
        },
        "press_enter": true,
        "text_label": "<string>"
      }
    ],
    "category": "homepage",
    "actions": [
      {
        "type": "form_fill",
        "category": "Special Browser Actions",
        "description": "Fill a form with multiple values. Critical: If you detect a form on a page, try to use this action at first, and otherwise use the regular fill action",
        "value": {}
      }
    ],
    "browser_actions": [
      {
        "type": "<string>",
        "category": "<string>",
        "description": "<string>",
        "value": {}
      }
    ],
    "markdown": "<string>"
  },
  "session": {
    "session_id": "<string>",
    "timeout_minutes": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "last_accessed_at": "2023-11-07T05:31:56Z",
    "duration": "<string>",
    "status": "active",
    "error": "<string>",
    "credit_usage": 123,
    "proxies": false,
    "browser_type": "chromium",
    "use_file_storage": false
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

session_id
string
required

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.