run

AI agent instructions

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.

Source: node-sdk/src/functions.ts Stream logs and wait for the final result by default. Pass { stream: false } to receive the backend’s JSON response without live logs. Disabling streaming does not make standard-runtime execution non-blocking. Pass functionRunId to execute a record returned by createRun().

NotteFunction.run(variables: Record<string, unknown>, options: FunctionRunOptions & { stream: false; }): Promise<FunctionRunStartResult>;
NotteFunction.run(variables?: Record<string, unknown>, options?: FunctionRunOptions & { stream?: true; }): Promise<FunctionRunResult>;
NotteFunction.run(variables: Record<string, unknown>, options: FunctionRunOptions): Promise<FunctionRunStartResult | FunctionRunResult>;

Parameters (overload 1)

Record<string, unknown>

required

FunctionRunOptions & { stream: false }

required

Returns (overload 1)

Promise<FunctionRunStartResult>

Parameters (overload 2)

Record<string, unknown>

FunctionRunOptions & { stream?: true }

Returns (overload 2)

Promise<FunctionRunResult>

Parameters (overload 3)

Record<string, unknown>

required

FunctionRunOptions

required

Returns (overload 3)

Promise<FunctionRunStartResult | FunctionRunResult>

⌘I

Getting Started

APIs

Python SDK

Node SDK

Parameters (overload 1)

Returns (overload 1)

Parameters (overload 2)

Returns (overload 2)

Parameters (overload 3)

Returns (overload 3)

​Parameters (overload 1)

​Returns (overload 1)

​Parameters (overload 2)

​Returns (overload 2)

​Parameters (overload 3)

​Returns (overload 3)

​Related types

Parameters (overload 1)

Returns (overload 1)

Parameters (overload 2)

Returns (overload 2)

Parameters (overload 3)

Returns (overload 3)

Related types