POST
/
env
/
observe
curl --location \
--request POST 'https://api.notte.cc/env/observe' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer your-api-key' \
--data '{
  "session_id": "abc123",
  "url": "https://example.com"
}'

{
  "session_id": "abc123",
  "title": "Example Domain",
  "url": "https://example.com",
  "timestamp": "2024-01-07T12:34:56Z",
  "screenshot": null,
  "data": "<html>...</html>",
  "space": {
    "description": "Available actions for the observed page.",
    "category": "navigation",
    "actions": [
      {
        "id": "navigate",
        "name": "Navigate",
        "description": "Navigate to a link on the page."
      }
    ]
  }
}

​
Parameters

​
session_id (opt)
string

Optional parameter to specify the session ID. The session ID of the session within which the environment will be observed.

​
url (req)
string

Required parameter to specify the URL to observe. The URL to analyze and fetch available actions.

​
keep_alive (opt)
boolean

Optional parameter to keep the session alive beyond its timeout period. Default is false.

​
session_timeout (opt)
integer

Optional parameter to set a custom timeout for the session. Specify the timeout in minutes. Default is 10.

​
Response

​
session_id
string

The unique identifier for the session used in the observation.

​
title
string

The title of the observed page.

​
url
string

The URL of the observed page.

​
timestamp
string

The timestamp when the observation was performed, in ISO 8601 format.

​
screenshot
string (base64) (opt)

A base64-encoded screenshot of the observed page, if requested.

​
data
string

The data retrieved during the observation.

​
space
object (opt)

The available action space, including descriptions and categories.

​
Error Responses

​
400
string

Invalid request. This error is returned when the input parameters are not valid or a required parameter is missing.

​
500
string

Internal server error. This error is returned when the server encounters an unexpected condition.

curl --location \
--request POST 'https://api.notte.cc/env/observe' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer your-api-key' \
--data '{
  "session_id": "abc123",
  "url": "https://example.com"
}'

{
  "session_id": "abc123",
  "title": "Example Domain",
  "url": "https://example.com",
  "timestamp": "2024-01-07T12:34:56Z",
  "screenshot": null,
  "data": "<html>...</html>",
  "space": {
    "description": "Available actions for the observed page.",
    "category": "navigation",
    "actions": [
      {
        "id": "navigate",
        "name": "Navigate",
        "description": "Navigate to a link on the page."
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
min_nb_actions
integer | null

The minimum number of actions to list before stopping. If not provided, the listing will continue until the maximum number of actions is reached.

​
max_nb_actions
integer
default:100

The maximum number of actions to list after which the listing will stop. Used when min_nb_actions is not provided.

​
session_id
string | null

The ID of the session. A new session is created when not provided.

​
keep_alive
boolean
default:false

If True, the session will not be closed after the operation is completed.

​
session_timeout_minutes
integer
default:5

Session timeout in minutes. Cannot exceed the global timeout.

Required range: 0 < x <= 30
​
screenshot
boolean | null

Whether to include a screenshot in the response.

​
url
string | null

The URL to observe. If not provided, uses the current page URL.

Response

200
application/json
Successful Response
​
session
object
required

Browser session information

​
metadata
object
required

Metadata of the current page, i.e url, page title, snapshot timestamp.

​
screenshot
file | null

Base64 encoded screenshot of the current page

​
data
object | null

Extracted data from the page

​
space
object | null

Available actions in the current state