client.sessions

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/client.ts Client-bound session API operations. list() retains its array return value. These operations use the configured client’s authentication and transport. Signatures below preserve positional arguments, optional parameters, and return types. See the OpenAPI schema for HTTP request and response fields.

list

client.sessions.list(options?: SessionListOptions): Promise<SessionResponse[]>;

authReadiness

sessionAuthReadiness: /sessions/{session_id}/auth. Returns the API response body.

client.sessions.authReadiness(sessionId: SessionAuthReadinessData["path"]["session_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionAuthReadinessData["headers"]>, "x-notte-api-key">; }): Promise<ManagedAuthReadiness>;

createPayment

createPayment: /sessions/{session_id}/payments. Returns the API response body.

client.sessions.createPayment(sessionId: CreatePaymentData["path"]["session_id"], body: CreatePaymentData["body"], query: CreatePaymentData["query"], requestOptions: ResourceRequestOptions & { headers: Omit<NonNullable<CreatePaymentData["headers"]>, "x-notte-api-key">; }): Promise<PaymentResponse>;

debugInfo

sessionDebugInfo: /sessions/{session_id}/debug. Returns the API response body.

client.sessions.debugInfo(sessionId: SessionDebugInfoData["path"]["session_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionDebugInfoData["headers"]>, "x-notte-api-key">; }): Promise<SessionDebugResponse>;

deleteSessionFile

deleteSessionFile: /sessions/{session_id}/files/{file_id}. Returns the API response body.

client.sessions.deleteSessionFile(sessionId: DeleteSessionFileData["path"]["session_id"], fileId: DeleteSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<DeleteSessionFileData["headers"]>, "x-notte-api-key">; }): Promise<void>;

downloadSessionFile

downloadSessionFile: /sessions/{session_id}/files/{file_id}. Returns the API response body.

client.sessions.downloadSessionFile(sessionId: DownloadSessionFileData["path"]["session_id"], fileId: DownloadSessionFileData["path"]["file_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<DownloadSessionFileData["headers"]>, "x-notte-api-key">; }): Promise<unknown>;

execute

pageExecute: /sessions/{session_id}/page/execute. Returns the API response body.

client.sessions.execute(sessionId: PageExecuteData["path"]["session_id"], body: PageExecuteData["body"], query?: PageExecuteData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<PageExecuteData["headers"]>, "x-notte-api-key">; }): Promise<ApiExecutionResponse>;

getCookies

sessionCookiesGet: /sessions/{session_id}/cookies. Returns the API response body.

client.sessions.getCookies(sessionId: SessionCookiesGetData["path"]["session_id"], query?: SessionCookiesGetData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionCookiesGetData["headers"]>, "x-notte-api-key">; }): Promise<GetCookiesResponse>;

getSessionScript

getSessionScript: /sessions/{session_id}/workflow/code. Returns the API response body.

client.sessions.getSessionScript(sessionId: GetSessionScriptData["path"]["session_id"], query: GetSessionScriptData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<GetSessionScriptData["headers"]>, "x-notte-api-key">; }): Promise<AgentFunctionCodeResponse>;

listSessionFiles

listSessionFiles: /sessions/{session_id}/files. Returns the API response body.

client.sessions.listSessionFiles(sessionId: ListSessionFilesData["path"]["session_id"], query?: ListSessionFilesData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<ListSessionFilesData["headers"]>, "x-notte-api-key">; }): Promise<SessionFilesPage>;

mouseReplay

sessionMouseReplay: /sessions/{session_id}/replay/mouse. Returns the API response body.

client.sessions.mouseReplay(sessionId: SessionMouseReplayData["path"]["session_id"], query?: SessionMouseReplayData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionMouseReplayData["headers"]>, "x-notte-api-key">; }): Promise<MouseReplayPage>;

networkLogs

sessionNetworkLogs: /sessions/{session_id}/network/logs. Returns the API response body.

client.sessions.networkLogs(sessionId: SessionNetworkLogsData["path"]["session_id"], query?: SessionNetworkLogsData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionNetworkLogsData["headers"]>, "x-notte-api-key">; }): Promise<NetworkLogsResponse>;

observe

pageObserve: /sessions/{session_id}/page/observe. Returns the API response body.

client.sessions.observe(sessionId: PageObserveData["path"]["session_id"], body: PageObserveData["body"], query?: PageObserveData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<PageObserveData["headers"]>, "x-notte-api-key">; }): Promise<Observation>;

offset

sessionOffset: /sessions/{session_id}/offset. Returns the API response body.

client.sessions.offset(sessionId: SessionOffsetData["path"]["session_id"], query?: SessionOffsetData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionOffsetData["headers"]>, "x-notte-api-key">; }): Promise<SessionOffsetResponse>;

pageScreenshot

pageScreenshot: /sessions/{session_id}/page/screenshot. Returns the API response body.

client.sessions.pageScreenshot(sessionId: PageScreenshotData["path"]["session_id"], query?: PageScreenshotData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<PageScreenshotData["headers"]>, "x-notte-api-key">; }): Promise<unknown>;

profilePreview

sessionProfilePreview: /sessions/{session_id}/profile-preview. Returns the API response body.

client.sessions.profilePreview(sessionId: SessionProfilePreviewData["path"]["session_id"], query?: SessionProfilePreviewData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionProfilePreviewData["headers"]>, "x-notte-api-key">; }): Promise<SessionProfilePreviewResponse>;

profileSave

sessionProfileSave: /sessions/{session_id}/profile/save. Returns the API response body.

client.sessions.profileSave(sessionId: SessionProfileSaveData["path"]["session_id"], body: SessionProfileSaveData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionProfileSaveData["headers"]>, "x-notte-api-key">; }): Promise<ProfileResponse>;

replay

sessionReplay: /sessions/{session_id}/replay. Returns the API response body.

client.sessions.replay(sessionId: SessionReplayData["path"]["session_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionReplayData["headers"]>, "x-notte-api-key">; }): Promise<ReplayResponse>;

scrape

pageScrape: /sessions/{session_id}/page/scrape. Returns the API response body.

client.sessions.scrape(sessionId: PageScrapeData["path"]["session_id"], body: PageScrapeData["body"], query?: PageScrapeData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<PageScrapeData["headers"]>, "x-notte-api-key">; }): Promise<DataSpace>;

setCookies

sessionCookiesSet: /sessions/{session_id}/cookies. Returns the API response body.

client.sessions.setCookies(sessionId: SessionCookiesSetData["path"]["session_id"], body: SessionCookiesSetData["body"], query?: SessionCookiesSetData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionCookiesSetData["headers"]>, "x-notte-api-key">; }): Promise<ExecutionResponse>;

start

sessionStart: /sessions/start. Returns the API response body.

client.sessions.start(body: SessionStartData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionStartData["headers"]>, "x-notte-api-key">; }): Promise<SessionResponse>;

status

sessionStatus: /sessions/{session_id}. Returns the API response body.

client.sessions.status(sessionId: SessionStatusData["path"]["session_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionStatusData["headers"]>, "x-notte-api-key">; }): Promise<SessionResponse>;

stop

sessionStop: /sessions/{session_id}/stop. Returns the API response body.

client.sessions.stop(sessionId: SessionStopData["path"]["session_id"], query?: SessionStopData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<SessionStopData["headers"]>, "x-notte-api-key">; }): Promise<SessionResponse>;

uploadSessionFile

uploadSessionFile: /sessions/{session_id}/files. Returns the API response body.

client.sessions.uploadSessionFile(sessionId: UploadSessionFileData["path"]["session_id"], body: UploadSessionFileData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<UploadSessionFileData["headers"]>, "x-notte-api-key">; }): Promise<SessionFile>;

Getting Started

APIs

Python SDK

Node SDK

client.sessions

list

authReadiness

createPayment

debugInfo

deleteSessionFile

downloadSessionFile

execute

getCookies

getSessionScript

listSessionFiles

mouseReplay

networkLogs

observe

offset

pageScreenshot

profilePreview

profileSave

replay

scrape

setCookies

start

status

stop

uploadSessionFile

​list

​authReadiness

​createPayment

​debugInfo

​deleteSessionFile

​downloadSessionFile

​execute

​getCookies

​getSessionScript

​listSessionFiles

​mouseReplay

​networkLogs

​observe

​offset

​pageScreenshot

​profilePreview

​profileSave

​replay

​scrape

​setCookies

​start

​status

​stop

​uploadSessionFile

list

authReadiness

createPayment

debugInfo

deleteSessionFile

downloadSessionFile

execute

getCookies

getSessionScript

listSessionFiles

mouseReplay

networkLogs

observe

offset

pageScreenshot

profilePreview

profileSave

replay

scrape

setCookies

start

status

stop

uploadSessionFile