---
title: "SDK: agent"
description: "The agent methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

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

# SDK: agent

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `agent` area has 9 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## agentApprovalDecide

Approve or deny an agent action

- Request: `POST` on `/v1/tenants/{tenantId}/agent/approvals/{approvalId}/decide`

```ts
agentApprovalDecide(args: { tenantId: string; approvalId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>
```

## agentApprovalGet

Read an agent approval card

- Request: `GET` on `/v1/tenants/{tenantId}/agent/approvals/{approvalId}`

```ts
agentApprovalGet(args: { tenantId: string; approvalId: string }, options?: CallOptions): Promise<AgentApprovalShow>
```

## agentApprovalUndo

Undo an approved agent action

- Request: `POST` on `/v1/tenants/{tenantId}/agent/approvals/{approvalId}/undo`

```ts
agentApprovalUndo(args: { tenantId: string; approvalId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>
```

## agentAudit

The Overlane Agent's audit trail

- Request: `GET` on `/v1/tenants/{tenantId}/agent/audit`

```ts
agentAudit(args: { tenantId: string }, options?: CallOptions): Promise<AgentAuditList>
```

## agentChat

Send the Overlane Agent a message

- Request: `POST` on `/v1/tenants/{tenantId}/agent/chat`

```ts
agentChat(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>
```

## agentConfig

The Overlane Agent's configuration for the team

- Request: `GET` on `/v1/tenants/{tenantId}/agent/config`

```ts
agentConfig(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## agentConversation

Read an agent conversation

- Request: `GET` on `/v1/tenants/{tenantId}/agent/conversations/{conversationId}`

```ts
agentConversation(args: { tenantId: string; conversationId: string }, options?: CallOptions): Promise<AgentConversation>
```

## agentFeedback

Rate an agent answer

- Request: `POST` on `/v1/tenants/{tenantId}/agent/feedback`

```ts
agentFeedback(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>
```

## agentReadonly

Turn the Overlane Agent's read-only mode on or off

- Request: `PUT` on `/v1/tenants/{tenantId}/agent/readonly`

```ts
agentReadonly(args: { tenantId: string; body: AgentReadOnlyRequest }, options?: CallOptions): Promise<AgentReadOnlyMode>
```

Source: https://docs.overlane.app/sdk/agent/index.mdx