SDKs

Narrative provides official SDKs for integrating with the platform programmatically. SDKs simplify authentication, provide type safety, and offer convenient methods for common operations.

Available SDKs

TypeScript SDK

Full-featured SDK for Node.js and TypeScript applications. Includes complete type definitions and supports all API operations.

When to use an SDK

Approach	Best for
Web UI	Manual operations, data exploration, one-off tasks
REST API	Custom integrations, languages without SDK support
SDK	TypeScript/JavaScript apps, type safety, rapid development

Benefits of using an SDK

Type safety - Full TypeScript support with autocomplete
Convenience - Pre-built methods for common operations
Authentication - Simplified API key management
Error handling - Consistent error types and messages
Documentation - Inline documentation and examples

Quick comparison

// With SDK
import { NarrativeApi } from '@narrative.io/data-collaboration-sdk-ts';

const api = new NarrativeApi({ apiKey: process.env.NARRATIVE_API_KEY });
const datasets = await api.getDatasets();

// With REST API directly
const response = await fetch('https://api.narrative.io/datasets', {
  headers: {
    'Authorization': `Bearer ${process.env.NARRATIVE_API_KEY}`,
    'Content-Type': 'application/json',
  },
});
const datasets = await response.json();

Getting started

Create an API key

Navigate to Settings > API Keys and create a new key with appropriate permissions.

Install the SDK

npm install @narrative.io/data-collaboration-sdk-ts

Initialize and use

import { NarrativeApi } from '@narrative.io/data-collaboration-sdk-ts';

const api = new NarrativeApi({
  apiKey: process.env.NARRATIVE_API_KEY,
});

const datasets = await api.getDatasets();

SDK Quickstart

Tutorial for first-time SDK users

API Keys

Create and manage API keys

REST API Reference

Full REST API documentation

SDK Guides

How-to guides for common tasks

Classifier Studio interface TypeScript SDK

⌘I

Overview

Connectors

Integrations

Workflow Reference

Webhook Reference

Security Reference

Architecture Reference

Error Reference

Model Inference Reference

Rosetta Stone Reference

UI Reference

Glossary

Billing

SDKs

Available SDKs

TypeScript SDK

When to use an SDK

Benefits of using an SDK

Quick comparison

Getting started

SDK Quickstart

API Keys

REST API Reference

SDK Guides

​Available SDKs

TypeScript SDK

​When to use an SDK

​Benefits of using an SDK

​Quick comparison

​Getting started

​Related resources

SDK Quickstart

API Keys

REST API Reference

SDK Guides

Available SDKs

When to use an SDK

Benefits of using an SDK

Quick comparison

Getting started

Related resources