@narrative.io/data-collaboration-sdk-ts) provides type-safe access to the Narrative API for Node.js and TypeScript applications.
Installation
- npm
- yarn
- bun
Quick start
Architecture
The SDK uses a mixin pattern to combine multiple API modules into a singleNarrativeApi class. This provides a unified interface while maintaining type safety for each module’s methods.
Available API modules
The SDK provides access to the following API modules:| Module | Methods | Description |
|---|---|---|
| NQL | executeNql(), compileNql(), validateNql(), parseNql() | Execute and analyze NQL queries |
| Datasets | getDatasets(), getDataset(), createDataset(), updateDataset(), deleteDataset() | Manage datasets |
| Jobs | getJobs(), getJob() | Track asynchronous job status |
| Model Inference | runModelInference() | Run LLM inference within data planes |
| Uploads | Upload file operations | Upload data to datasets |
| Access Rules | getAccessRules(), createAccessRule(), updateAccessRule(), deleteAccessRule() | Manage permissions |
| Mappings | Rosetta Stone mapping operations | Work with schema mappings |
| Data Planes | getDataPlanes() | Data plane operations |
| Subscriptions | getSubscriptions() | Manage data subscriptions |
| Access Tokens | Token management operations | Manage API tokens |
Requirements
- Node.js: 18 or later
- TypeScript: 4.7 or later (for TypeScript users)

