# @onvo-ai/js

> The javascript SDK for Onvo AI dashboard builder

Latest version **0.17.69** (published 2026-03-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @onvo-ai/js
pnpm add @onvo-ai/js
yarn add @onvo-ai/js
bun add @onvo-ai/js
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.17.69 |
| Published | 2026-03-06 |
| First published | 2024-01-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 771.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ronnel Davis |
| Maintainers | ronneldavis |
| Keywords | onvo, sdk, dashboard, builder, reports, analytics, ai, visualization |

## Links

- npm: https://www.npmjs.com/package/@onvo-ai/js
- Repository: https://github.com/onvo-ai/sdks
- Homepage: https://github.com/onvo-ai/sdks/tree/main/js
- Issues: https://github.com/onvo-ai/sdks/issues
- npm.io page: https://npm.io/package/@onvo-ai/js

## Dependencies (7)

- [zod](https://npm.io/package/zod.md) ^3.24.3
- [nanoid](https://npm.io/package/nanoid.md) ^5.1.5
- [pusher-js](https://npm.io/package/pusher-js.md) ^8.4.0
- [web-file-polyfill](https://npm.io/package/web-file-polyfill.md) ^1.0.4
- [@supabase/supabase-js](https://npm.io/package/@supabase/supabase-js.md) ^2.57.4
- [@badgateway/oauth2-client](https://npm.io/package/@badgateway/oauth2-client.md) ^3.2.0
- [@asteasolutions/zod-to-openapi](https://npm.io/package/@asteasolutions/zod-to-openapi.md) ^7.3.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.17.69 (latest) — 2026-03-06
- 0.15.0 (beta) — 2025-06-20
- 0.17.67 — 2026-03-05
- 0.17.65 — 2026-02-05
- 0.17.64 — 2026-02-05
- 0.17.63 — 2026-02-05
- 0.17.61 — 2025-10-30
- 0.17.60 — 2025-10-30
- 0.17.59 — 2025-10-12
- 0.17.58 — 2025-10-10
- 0.17.57 — 2025-09-24
- 0.17.56 — 2025-09-24
- 0.17.55 — 2025-09-24
- 0.17.54 — 2025-09-24
- 0.17.53 — 2025-09-24
- … 241 more at https://npm.io/package/@onvo-ai/js/versions

## README

# @onvo-ai/js

The @onvo-ai/js package provides utilities to seamlessly communicate with the Onvo platform, allowing developers to integrate AI-powered dashboards into their products. This README provides an overview of the package's features, installation, and usage instructions.

## Installation

You can install the package using npm:

```bash
npm install @onvo-ai/js
```

OR

```bash
yarn add @onvo-ai/js
```

OR

```bash
bun install @onvo-ai/js
```

## Getting Started

To begin using the `@onvo-ai/js` package, you'll need to have an API key from the Onvo platform. Ensure that your API key is stored as an environment variable named `API_KEY`.

```bash
API_KEY=your_api_key
```

## Usage

Here's an example of how to use the package to interact with the Onvo platform:

```javascript
const Onvo = require("@onvo-ai/js");

// Initialize the Onvo class with your API key
const onvo = new Onvo(process.env.API_KEY);

// Identify a user
await onvo.embed_users.upsert("123456", {
  name: "John Appleseed",
  email: "john@appleseed.com",
  metadata: {
    phone_number: "+1 234 5678",
    organisation_id: "87dfty9872ydq8tg",
  },
});

// Create a session
const sessionUrl = await onvo.sessions.upsert({
  embed_user: "123456",
  parent_dashboard: "ebc7ab74-3fd2-47e6-90df-addaec3a029e",
  parameters: {
    year: 2023,
    sort: "asc",
  },
});
```

## Library Reference

**`new Onvo(apiKey, options)`**
_This is the main class that initializes the connection to the Onvo platform._

- `apiKey (string)`: Your API key for authentication.
- `options`:
  - `baseUrl (string)`: The base URL to the Onvo platform or your self hosted endpoint.

### Accounts

```typescript
onvo.accounts.list()
onvo.accounts.get(id:string)
```

### Automations

```typescript
onvo.automations.list()
onvo.automations.create(body:object)
onvo.automations.get(id:string)
onvo.automations.update(id:string, body:object)
onvo.automations.delete(id:string)

onvo.automation(id:string).getRuns()
```

### Dashboards

```typescript
onvo.dashboards.list()
onvo.dashboards.create(body:object)
onvo.dashboards.get(id:string)
onvo.dashboards.update(id:string, body:object)
onvo.dashboards.delete(id:string)

onvo.dashboard(id:string).updateWidgetCache()

onvo.dashboard(dashboardId:string).datasources.list()
onvo.dashboard(dashboardId:string).datasources.link(datasourceId:string)
onvo.dashboard(dashboardId:string).datasources.unlink(datasourceId:string)
```

### Datasources

```typescript
onvo.datasources.list()
onvo.datasources.create(body:object)
onvo.datasources.get(id:string)
onvo.datasources.update(id:string, body:object)
onvo.datasources.delete(id:string)

onvo.datasource(id:string).getData()
onvo.datasource(id:string).fetchColumnDescriptions()
```

### Embed Users

```typescript
onvo.embed_users.list()
onvo.embed_users.get(id:string)
onvo.embed_users.upsert(id:string, body:object)
onvo.embed_users.delete(id:string)

onvo.embed_user(id:string).getAccessToken()
```

### Questions

```typescript
onvo.widgets.list(filters: object)
onvo.widgets.create(body:object)
onvo.widgets.delete(id:string)
```

### Sessions

```typescript
onvo.sessions.list(filters: object)
onvo.sessions.delete(id:string)
onvo.sessions.revokeAll(body:object)
onvo.sessions.upsert(body:object)
```

### Teams

```typescript
onvo.teams.list(filters: object)
onvo.teams.get(id:string)
onvo.teams.update(id:string, body:object)
```

### Widgets

```typescript
onvo.widgets.list(filters: object)
onvo.widgets.create(body:object)
onvo.widgets.get(id:string)
onvo.widgets.update(id:string, body:object)
onvo.widgets.delete(id:string)

onvo.widget(id:string).getImage()
```

## Support

For any issues, questions, or feedback, please contact our support team at info@onvo.ai.

## License

This package is distributed under the MIT License.

Thank you for choosing the @onvo-ai/js package to integrate AI-powered dashboards from the Onvo platform into your product! We hope this package enhances your development experience and empowers your applications with advanced analytics capabilities.

---
_Source: https://npm.io/package/@onvo-ai/js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._