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_id": "<string>",
  "error": "<string>",
  "title": "<string>",
  "url": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": "",
  "space": {
    "description": "<string>",
    "actions": [
      {
        "id": "<string>",
        "description": "<string>",
        "category": "<string>",
        "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

keep_alive

boolean

default:false

session_timeout

integer

default:10

screenshot

boolean | null

Response

200

application/json

Successful Response

session_id

string

required

title

string

required

url

string

required

timestamp

string

required

content

string

required

error

string | null

screenshot

file | null

data

string

default:

space

object | null

Scrape

{
  "session_id": "<string>",
  "error": "<string>",
  "title": "<string>",
  "url": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": "",
  "space": {
    "description": "<string>",
    "actions": [
      {
        "id": "<string>",
        "description": "<string>",
        "category": "<string>",
        "params": [
          {
            "name": "<string>",
            "type": "<string>",
            "default": "<string>",
            "values": [
              "<string>"
            ]
          }
        ],
        "status": "valid"
      }
    ],
    "category": "<string>"
  },
  "content": "<string>"
}