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.
Source: node-sdk/src/lib/client/types.gen.ts

Fields

string
required
URL to download file from
"standard" | "extended" | undefined
string
required
The ID of the function
ParameterInfo[] | null | undefined
The variables to run the workflow with
string
required
The creation time of the workflow
string
required
The last update time of the workflow
string
required
The version of the workflow
string[]
required
The versions of the workflow
string
required
The status of the workflow
string | null | undefined
The name of the workflow
string | null | undefined
The description of the workflow
boolean | undefined
Whether the workflow is public and can beshared with other users
string | null | undefined
The ID of the reference workflow (i.e wether the workflow was forked from another workflow or not)
boolean | undefined
string[] | undefined
string | null | undefined
Where the function was created from, stamped at creation. Read-only.
boolean | undefined
Whether the build is finished and the function may be healed automatically. Can only be enabled on a function that has a thread for self-heal to resume.
string | null | undefined
The site this function drives, used to group endpoints in the console. Null when the function never named a site.
string | null | undefined
Builder’s operating notes: typical run duration, known failure modes, which parameters matter.
{ [key: string]: unknown; } | null | undefined
JSON Schema of the value run() returns, or null when the author never documented one.
string | null | undefined
Cron expression the function runs on, or null if it is not scheduled.
{ [key: string]: unknown; } | null | undefined
Variables passed to each scheduled run, or null if it is not scheduled.
"enabled" | "paused" | null | undefined
‘enabled’ while the schedule fires, ‘paused’ once the backend disabled it after a deterministic failure (exhausted credit, or an inactive function), null when there is no schedule.
string
required