> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notte.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# client.agents

<Tip>
  Read [the Notte skill](https://notte.cc/skill.md) 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.
</Tip>

[Source: node-sdk/src/client.ts](https://github.com/nottelabs/notte/blob/main/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](https://api.notte.cc/openapi.json) for HTTP request and response fields.

## list

```typescript theme={null}
client.agents.list(options?: AgentListOptions): Promise<AgentResponse[]>;
```

## getScript

getScript: /agents/\{agent\_id}/workflow/code. Returns the API response body.

```typescript theme={null}
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.

```typescript theme={null}
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.

```typescript theme={null}
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.

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.