client.agents

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 agent 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.agents.list(options?: AgentListOptions): Promise<AgentResponse[]>;

getScript

getScript: /agents/{agent_id}/workflow/code. Returns the API response body.

client.agents.getScript(agentId: GetScriptData["path"]["agent_id"], query: GetScriptData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<GetScriptData["headers"]>, "x-notte-api-key">; }): Promise<AgentFunctionCodeResponse>;

start

agentStart: /agents/start. Returns the API response body.

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

status

agentStatus: /agents/{agent_id}. Returns the API response body.

client.agents.status(agentId: AgentStatusData["path"]["agent_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<AgentStatusData["headers"]>, "x-notte-api-key">; }): Promise<LegacyAgentStatusResponse>;

stop

agentStop: /agents/{agent_id}/stop. Returns the API response body.

client.agents.stop(agentId: AgentStopData["path"]["agent_id"], query: AgentStopData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<AgentStopData["headers"]>, "x-notte-api-key">; }): Promise<AgentStatusResponse>;

⌘I

Getting Started

APIs

Python SDK

Node SDK

client.agents

list

getScript

start

status

stop

​list

​getScript

​start

​status

​stop

list

getScript

start

status

stop