API Reference

Chat

Executes actions in the Notte environment based on LLM decisions.

This method demonstrates how to:

Parse LLM output into Notte commands
Execute those commands in the environment
Format the results back into text for the LLM

Users should customize this method to:

Handle additional Notte endpoints
Implement custom error handling
Format observations specifically for their LLM

Args: content: The LLM’s response containing the desired action

Returns: content: Formatted observation from the environment

POST

env

chat

{
  "session": {
    "session_id": "<string>",
    "timeout_minutes": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "last_accessed_at": "2023-11-07T05:31:56Z",
    "duration": "<string>",
    "status": "active",
    "error": "<string>"
  },
  "metadata": {
    "title": "<string>",
    "url": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "markdown": "<string>",
    "images": [
      {
        "id": "<string>",
        "url": "<string>",
        "category": "icon"
      }
    ],
    "structured": [
      {}
    ]
  },
  "space": {
    "markdown": "<string>",
    "description": "<string>",
    "actions": [
      {
        "id": "<string>",
        "description": "<string>",
        "category": "<string>",
        "params": [
          {
            "name": "<string>",
            "type": "<string>",
            "default": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "status": "valid"
      }
    ],
    "special_actions": [
      {
        "id": "<string>",
        "description": "Special action",
        "category": "Special Browser Actions",
        "params": [
          {
            "name": "<string>",
            "type": "<string>",
            "default": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "status": "valid"
      }
    ],
    "category": "<string>"
  },
  "content": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

content

string

required

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.

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.

content

string

required

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

Scrape

{
  "session": {
    "session_id": "<string>",
    "timeout_minutes": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "last_accessed_at": "2023-11-07T05:31:56Z",
    "duration": "<string>",
    "status": "active",
    "error": "<string>"
  },
  "metadata": {
    "title": "<string>",
    "url": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "markdown": "<string>",
    "images": [
      {
        "id": "<string>",
        "url": "<string>",
        "category": "icon"
      }
    ],
    "structured": [
      {}
    ]
  },
  "space": {
    "markdown": "<string>",
    "description": "<string>",
    "actions": [
      {
        "id": "<string>",
        "description": "<string>",
        "category": "<string>",
        "params": [
          {
            "name": "<string>",
            "type": "<string>",
            "default": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "status": "valid"
      }
    ],
    "special_actions": [
      {
        "id": "<string>",
        "description": "Special action",
        "category": "Special Browser Actions",
        "params": [
          {
            "name": "<string>",
            "type": "<string>",
            "default": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "status": "valid"
      }
    ],
    "category": "<string>"
  },
  "content": "<string>"
}