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"
  },
  "space": {
    "description": "<string>",
    "interaction_actions": [
      {
        "type": "click",
        "category": "Interaction Actions",
        "description": "Click on an element of the current page",
        "id": "<string>"
      }
    ],
    "category": "homepage",
    "actions": [
      {
        "type": "goto",
        "category": "Special Browser Actions",
        "description": "Goto to a URL (in current tab)",
        "url": "<string>"
      }
    ],
    "browser_actions": [
      {
        "type": "<string>",
        "category": "<string>",
        "description": "<string>",
        "url": "<string>"
      }
    ],
    "markdown": "<string>"
  },
  "data": {
    "markdown": "<string>",
    "images": [
      {
        "url": "<string>",
        "category": "favicon",
        "description": "<string>"
      }
    ],
    "structured": {
      "success": true,
      "error": "<string>",
      "data": {}
    }
  },
  "progress": {
    "current_step": 123,
    "max_steps": 123
  },
  "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>",
    "proxies": false,
    "browser_type": "chromium"
  }
}

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.