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

# CharAgentProps

> Generated API reference for CharAgentProps.

# Interface: CharAgentProps

React props for the `CharAgent` wrapper.

Auth contract:

* `publishableKey` required
* `idToken` optional

## Extends

* `Omit`\<`HTMLAttributes`\<[`CharAgentElement`](CharAgentElement)>, `"children"` | `"onError"`>

## Properties

### apiBase?

> `optional` **apiBase**: `string`

***

### displayMode?

> `optional` **displayMode**: [`CharDisplayMode`](../type-aliases/CharDisplayMode)

***

### enableDebugTools?

> `optional` **enableDebugTools**: `boolean`

***

### idToken?

> `optional` **idToken**: `string`

***

### onCharClose()?

> `optional` **onCharClose**: () => `void`

#### Returns

`void`

***

### onCharError()?

> `optional` **onCharError**: (`detail`) => `void`

#### Parameters

##### detail

[`CharErrorDetail`](CharErrorDetail)

#### Returns

`void`

***

### onCharInitialized()?

> `optional` **onCharInitialized**: () => `void`

#### Returns

`void`

***

### onCharOpenLink()?

> `optional` **onCharOpenLink**: (`detail`) => `void`

#### Parameters

##### detail

[`CharOpenLinkDetail`](CharOpenLinkDetail)

#### Returns

`void`

***

### onCharRequestDisplayMode()?

> `optional` **onCharRequestDisplayMode**: (`detail`) => `void`

#### Parameters

##### detail

[`CharRequestDisplayModeDetail`](CharRequestDisplayModeDetail)

#### Returns

`void`

***

### onCharSizeChanged()?

> `optional` **onCharSizeChanged**: (`detail`) => `void`

#### Parameters

##### detail

[`CharSizeChangedDetail`](CharSizeChangedDetail)

#### Returns

`void`

***

### publishableKey

> **publishableKey**: `string`