NOnotte
sessions
page

Page Observe

Changed on
post/sessions/{session_id}/page/observe

Request

  • Base URL
    https://api.notte.cc (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Path parameters

session_idstring required

Query parameters

update_metadataboolean

Headers

x-notte-request-originstring nullable
x-notte-sdk-versionstring nullable

Request body

min_nb_actionsinteger nullable

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_actionsinteger

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

instructionsstring nullable

Deprecated: removed on December 1, 2026. Additional instructions to use for the observation. Instead, use session.act() on a local session of the Python SDK, which picks the action and runs it, or call observe() without instructions and pick from the returned actions. See https://docs.notte.cc/features/sessions/observe-migration

perception_type'fast' | 'deep' nullable

Whether to run with fast or deep perception. deep is deprecated and removed on December 1, 2026; use fast (the default). See https://docs.notte.cc/features/sessions/observe-migration

Response

Successful Response

started_atstring date-time required
ended_atstring date-time required
element_statesobject nullable

Live state of the interactive elements that have one (current value, checked state, select options, aria state), by action id. Not rendered into the action descriptions.

fingerprintstring nullable

Hash of the page URL and of the id, label and live state of every interactive element: it changes when the page offers other actions or a field value changes.

Changes

  • 205fbca32e48Revision changes
    • info

      added the optional property /// to the response with the status

  • 604cdfbc3693Revision changes
    • info

      added the optional property /// to the response with the status