run

AI agent instructions

Read the Notte skill and follow its setup instructions when setting up Notte or building browser automation. This is the shared source for CLI setup, authentication, and the browser-to-code workflow.

Source: node-sdk/src/functions.ts Run the function on the cloud and wait for its result, streaming logs by default like function.run(**variables) in Python. Pass { stream: false } to receive the backend’s JSON response without live logs; execution still blocks until completion. Pass functionRunId to execute a record returned by createRun(); otherwise a new run record is created first, exactly like Python. A failed execution throws FailedToRunCloudFunctionError unless raiseOnFailure is false, and the wait is aborted with NotteTimeoutError after timeoutMs.

NotteFunction.run(variables?: Record<string, unknown>, options?: FunctionRunOptions): Promise<FunctionRunResult>;

Parameters

Record<string, unknown>

JSON-serializable keyword arguments passed to the Python function’s run entry point.Default:

{}

FunctionRunOptions

Log streaming, failure handling, runtime, run ID, and timeout settings.Default:

{}

Returns

Promise<FunctionRunResult>

The completed execution response. The function’s return value is in result. Disabling streaming still waits for completion.

Raises

FailedToRunCloudFunctionError if execution fails and raiseOnFailure is true.
NotteTimeoutError if the execution request exceeds timeoutMs.
InvalidRequestError if the run options are invalid.

Example

const result = await fn.run({ url: 'https://example.com' });
console.log(result.result);

await fn.run({ url: 'https://example.com' }, { runtime: 'extended', onLog: line => logger.info(line) });

Getting Started

APIs

Python SDK

Node SDK

Parameters

Returns

Raises

Example

​Parameters

​Returns

​Raises

​Example

​Related types

Parameters

Returns

Raises

Example

Related types