Official JavaScript/TypeScript SDK for building custom applications powered by HyperFlow flow-graphs.

Build AI chatbots, document analyzers, and custom workflows with minimal code. The SDK handles all Control API complexity—state management, streaming, interaction specs, and session lifecycle—letting you focus on your application's UI and business logic.

Version: 1.1.1

Features

• Headless Core SDK - Framework-agnostic Control API client
• React Hooks - useHyperFlow hook with state management
• TypeScript - Full type definitions included
• Streaming - Automatic LLM streaming with typing animation
• State Management - Handles interaction specs, step indices, session lifecycle
• Session Continuity - True session resumption with same sessionID (v1.1)
• File Upload Helpers - Auto-generate URLs for uploaded files (v1.1)
• Debug Mode - Verbose logging for development
• Production-Tested - Based on HyperFlow's own chatbot implementations

Installation

Current: Local/Tarball Install

# From tarball
yarn add file:./hyperflow-client-sdk-v1.1.0.tgz

# Or from local directory (during development)
yarn add file:/path/to/hyperflow-mono/src/sdk

Future: NPM Package

npm install @hyperflow/client-sdk
# or
yarn add @hyperflow/client-sdk

Quick Start

1. Get Your API Key