<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [InstallXOptions](./x-components.installxoptions.md) &gt; [api](./x-components.installxoptions.api.md)

## InstallXOptions.api property

The API to expose globally. If is not passed the default [BaseXAPI](./x-components.basexapi.md) will be used. If a `false` value is passed then the API is not created.

**Signature:**

```typescript
api?: API | false;
```