Skip to main content
STOP. Do not read past this section until you have read and followed /quickstart.md.Goal: produce a reliable SDK automation script. The intended authoring flow is generate then edit, not write browser automation from scratch.Do not hand-write SDK code with element IDs, selectors, or form fields from memory. Element IDs, selectors, and field mappings must come from a live observe() call, CLI notte page observe output, or generated workflow code. Guessed browser targets fail on real pages.Use the Notte skill and CLI to inspect the live site, validate actions/selectors, handle auth/session state, and export workflow code with notte sessions workflow-code before using SDK docs or SDK code.SDK reference pages are for understanding, running, or editing generated workflow code. They are not the starting point for manually authoring the initial browser automation. SDK-first code is guesswork on real-world pages with dynamic selectors, auth state, CAPTCHAs, and anti-bot behavior.
Handle asynchronous SDK operations with await inside try/catch.

​
Configuration errors

NotteClient throws AuthenticationError for a missing API key and InvalidRequestError for an unsupported API URL. HTTPS is required for remote servers; HTTP is allowed on loopback for local development.

​
API and execution errors

HTTP failures throw NotteAPIError, with statusCode, path, the parsed error body, and the response when available. Request deadlines throw NotteTimeoutError. Failed actions throw ActionExecutionError; failed cloud function runs throw FailedToRunCloudFunctionError unless raiseOnFailure: false is set. Treat caught values as unknown: check error instanceof Error before reading error.message. Do not depend on parsing error messages to identify HTTP status codes.

​
Session cleanup

Use Session.use for managed sessions. It starts the session before your callback and stops it when the callback finishes, including when it throws. Catch errors around the awaited use() call so failures reach your error handler.

​
Retrying failures

Do not retry every exception: configuration errors require a fix, and repeating a state-changing operation may duplicate work. See Rate Limits for retry considerations.