page
Observe
page
Observe
Detect available actions on a webpage within the session’s environment.
Returns a snapshot of the current state including available actions, metadata, and optional screenshot.
The optional url
parameter is used to navigate to a specific URL before observing the page.
If not provided, the session will remain on the current page.
POST
/
sessions
/
{session_id}
/
page
/
observe
{
"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"
},
"space": {
"markdown": "<string>",
"actions": [
{
"id": "<string>",
"description": "<string>",
"category": "<string>",
"params": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>",
"values": [
"<string>"
]
}
],
"status": "valid"
}
],
"browser_actions": [
{
"id": "S1",
"description": "Special action",
"category": "Special Browser Actions",
"params": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>",
"values": [
"<string>"
]
}
],
"status": "valid"
}
],
"description": "<string>",
"category": "<string>"
},
"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"
},
"data": {
"markdown": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"category": "icon"
}
],
"structured": {
"success": true,
"error": "<string>",
"data": {}
}
},
"progress": {
"current_step": 123,
"max_steps": 123
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
{
"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"
},
"space": {
"markdown": "<string>",
"actions": [
{
"id": "<string>",
"description": "<string>",
"category": "<string>",
"params": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>",
"values": [
"<string>"
]
}
],
"status": "valid"
}
],
"browser_actions": [
{
"id": "S1",
"description": "Special action",
"category": "Special Browser Actions",
"params": [
{
"name": "<string>",
"type": "<string>",
"default": "<string>",
"values": [
"<string>"
]
}
],
"status": "valid"
}
],
"description": "<string>",
"category": "<string>"
},
"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"
},
"data": {
"markdown": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"category": "icon"
}
],
"structured": {
"success": true,
"error": "<string>",
"data": {}
}
},
"progress": {
"current_step": 123,
"max_steps": 123
}
}