The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Neurolink listing page.
The pipe layer for the AI nervous system.
AI intelligence flows as streams — tokens, tool calls, memory, voice, documents. NeuroLink is the vascular layer that carries these streams from where they are generated (LLM providers: the neurons) to where they are needed (connectors: the organs).
→ Docs · → Quick Start · → npm
NeuroLink is the universal AI integration platform that unifies 30+ AI providers and 100+ models under one consistent API.
Extracted from production systems at Juspay, NeuroLink provides a practical, TypeScript-first way to integrate AI into any application. Whether you're building with OpenAI, Anthropic, Google, AWS Bedrock, Azure, or any of our 30+ supported providers, NeuroLink gives you a single, consistent interface that works everywhere.
Why NeuroLink? Switch providers with a single parameter change, leverage built-in tools plus any MCP-compliant tool server, deploy with confidence using enterprise features like Redis memory and multi-provider failover, and optimize costs automatically with intelligent routing. Use it via our professional CLI or TypeScript SDK—whichever fits your workflow.
Where we're headed: We're building for the future of AI—edge-first execution and continuous streaming architectures that make AI practically free and universally available. Read our vision →
| Feature | Version | Description | Guide |
|---|---|---|---|
| SambaNova Provider | next | RDU-accelerated open-weight flagships: Llama 3.3 70B (default), GPT-OSS 120B, DeepSeek V3.x, MiniMax, Gemma 4 (vision) — OpenAI-compatible Tier 2 catalog entry. Note: new SambaNova accounts require purchased credits. | SambaNova Guide |
| Cerebras Provider | next | Wafer-scale inference at ~3000 tok/s: GPT-OSS 120B (default) + Gemma 4 31B, OpenAI-compatible Tier 2 catalog entry, live-verified end to end (generate, stream, tools, structured output). | Cerebras Guide |
| Avatar / Music Modalities + 12 Providers | next | New output: { mode: "avatar" | "music" } dispatch with handlers for D-ID, HeyGen, Replicate-MuseTalk (avatar) and Beatoven, ElevenLabs Music, Lyria, Replicate-MusicGen (music). Plus Fish Audio TTS, Kling/Runway/Replicate video, xAI/Groq/Cohere/Together/Fireworks/Perplexity/Cloudflare LLMs, Voyage/Jina embeddings, Stability/Ideogram/Recraft/Replicate image-gen. | Provider Integration |
| Multi-Provider Voice (TTS/STT) | v9.62.0 | 6 TTS providers (OpenAI TTS, ElevenLabs, Google TTS, Azure TTS, Fish Audio, Cartesia) + 4 STT providers (Whisper, Deepgram, Azure STT, Google STT) + 2 realtime APIs (OpenAI Realtime, Gemini Live). | TTS Guide | STT Guide | Realtime Guide |
| 4 New Providers | v9.60.0 | DeepSeek (V3/R1), NVIDIA NIM (400+ catalog), LM Studio (local), llama.cpp (GGUF local). | Provider Setup |
| ModelAccessDeniedError | v9.59.0 | Typed ModelAccessDeniedError + sdk.checkCredentials() API for proactive credential validation before first call. | Error Reference |
| Provider Fallback Policy | v9.58.0 | providerFallback callback + modelChain config for centralized multi-provider fallback logic. | Advanced Guide |
| Per-Request Credentials | v9.52.0 | Pass credentials per-call or per-instance for all providers. Per-call overrides instance; instance overrides env vars. | Credentials Guide |
| AutoResearch | v9.53.0 | Autonomous AI experiment engine: proposes code changes, runs experiments, evaluates metrics — unattended for hours. | AutoResearch Guide |
| Gemini 3 Multi-turn Tool Fix | v9.49.0 | Fixed multi-step agentic tool calling on Vertex AI Gemini 3. Correct thoughtSignature replay, stepIndex grouping, executionId session isolation, 5-min timeout. | Vertex AI Guide |
| MCP Enhancements | v9.16.0 | Tool routing (6 strategies), result caching (LRU/FIFO/LFU), request batching, annotations, elicitation protocol, multi-server management. | MCP Enhancements Guide |
| Memory | v9.12.0 | Per-user condensed memory across conversations. LLM-powered condensation with S3, Redis, or SQLite. | Memory Guide |
| Context Window Management | v9.2.0 | 4-stage compaction pipeline with budget gate at 80% usage, per-provider token estimation. | Context Compaction Guide |
| Tool Execution Control | v9.3.0 | prepareStep and toolChoice for per-step tool enforcement in multi-step agentic loops. | API Reference |
| File Processor System | v9.1.0 | 17+ file type processors with ProcessorRegistry, security sanitization, SVG text injection. | File Processors Guide |
| RAG with generate()/stream() | v9.2.0 | Pass rag: { files } for automatic document chunking, embedding, and AI-powered search. 10 chunking strategies, hybrid search, reranking. | RAG Guide |
generate() and stream() call.conversation:titleGenerated event + NEUROLINK_TITLE_PROMPT custom titles. → Guideschema + output.format: "json". → GuideNeuroLink includes a HITL (Human-in-the-Loop) system for regulated industries and high-stakes AI operations:
| Capability | Description | Use Case |
|---|---|---|
| Tool Approval Workflows | Require human approval before AI executes sensitive tools | Financial transactions, data modifications |
| Output Validation | Route AI outputs through human review pipelines | Medical diagnosis, legal documents |
| Confidence Thresholds | Automatically trigger human review below confidence level | Critical business decisions |
| Complete Audit Trail | Audit logging to support your compliance program (HIPAA / SOC 2 / GDPR) | Regulated industries |
Enterprise HITL Guide | Quick Start
This guide will have you generating AI responses in under 5 minutes using either the SDK or CLI.
Choose your preferred package manager:
NeuroLink works with 30+ AI providers. You'll need at least one API key to get started:
Option 1: Interactive Setup (Recommended)
The wizard will guide you through:
Option 2: Manual Configuration
Create a .env file in your project root:
Free Tier Options:
Basic Text Generation:
Streaming Responses:
Multimodal Input (Images + Text):
Using Tools:
Basic Generation:
Multimodal Input:
Interactive Loop Mode:
RAG (Retrieval-Augmented Generation):
Structured Output with Zod:
External MCP Servers (GitHub, Slack, etc.):
Issue: "Provider not configured"
npx @juspay/neurolink setup or add provider API key to .envIssue: Rate limit errors
provider: "litellm" with LiteLLM to proxy across many providersIssue: Large context overflows
new NeuroLink({ conversationMemory: { enabled: true } })rag option to search documents instead of sending full contentNeed help? Check our Troubleshooting Guide or open an issue.
NeuroLink is a comprehensive AI development platform. Every feature below is shipped and documented.
30+ providers unified under one API - Switch providers with a single parameter change.
| Provider | Models | Free Tier | Tool Support | Status | Documentation |
|---|---|---|---|---|---|
| OpenAI | GPT-4o, GPT-4o-mini, o1 | ❌ | ✅ Full | ✅ Production | Setup Guide |
| Anthropic | Claude 4.6 Opus/Sonnet, Claude 4.5 Opus/Sonnet/Haiku, Claude 4 Opus/Sonnet | ❌ | ✅ Full | ✅ Production | Setup Guide | Subscription Guide |
| Google AI Studio | Gemini 3 Flash/Pro, Gemini 2.5 Flash/Pro | ✅ Free Tier | ✅ Full | ✅ Production | Setup Guide |
| AWS Bedrock | Claude, Titan, Llama, Nova | ❌ | ✅ Full | ✅ Production | Setup Guide |
| Google Vertex | Gemini 3/2.5 (gemini-3-*-preview) | ❌ | ✅ Full | ✅ Production | Setup Guide |
| Azure OpenAI | GPT-4, GPT-4o, o1 | ❌ | ✅ Full | ✅ Production | Setup Guide |
| LiteLLM | 100+ models unified | Varies | ✅ Full | ✅ Production | Setup Guide |
| AWS SageMaker | Custom deployed models | ❌ | ✅ Full | ✅ Production | Setup Guide |
| Mistral AI | Mistral Large, Small | ✅ Free Tier | ✅ Full | ✅ Production | Setup Guide |
| Hugging Face | 100,000+ models | ✅ Free | ⚠️ Partial | ✅ Production | Setup Guide |
| Ollama | Local models (Llama, Mistral) | ✅ Free (Local) | ⚠️ Partial | ✅ Production | Setup Guide |
| OpenAI Compatible | Any OpenAI-compatible endpoint | Varies | ✅ Full | ✅ Production | Setup Guide |
| OpenRouter | 300+ models via OpenRouter | Varies | ✅ Full | ✅ Production | Setup Guide |
| DeepSeek | deepseek-chat (V3), deepseek-reasoner (R1) | ❌ | ✅ Full | ✅ Production | Setup Guide |
| NVIDIA NIM | Llama 3.3 70B, 400+ catalog models | ❌ | ✅ Full | ✅ Production | Setup Guide |
| LM Studio | Any model loaded in LM Studio (local) | ✅ Free (Local) | ✅ Full | ✅ Production | Setup Guide |
| llama.cpp | Any GGUF model served by llama-server (local) | ✅ Free (Local) | ✅ Full | ✅ Production | Setup Guide |
| OpenAI TTS | TTS-1, TTS-1-HD, GPT-4o Audio | ❌ | N/A | ✅ Production | Setup Guide |
| ElevenLabs | Multilingual v2, Turbo v2.5, Flash v2.5 | ✅ Free Tier | N/A | ✅ Production | Setup Guide |
| Deepgram | Nova-3, Nova-2, Enhanced, Base (STT) | ✅ Free Tier | N/A | ✅ Production | Setup Guide |
| Azure Speech | Azure Cognitive Services TTS + STT | ❌ | N/A | ✅ Production | Setup Guide |
📖 Provider Comparison Guide - Detailed feature matrix and selection criteria 🔬 Provider Feature Compatibility - Test-based compatibility reference for all 19 features across 30+ providers
6 Core Tools (work across all providers, zero configuration):
| Tool | Purpose | Auto-Available | Documentation |
|---|---|---|---|
getCurrentTime | Real-time clock access | ✅ | Tool Reference |
readFile | File system reading | ✅ | Tool Reference |
writeFile | File system writing | ✅ | Tool Reference |
listDirectory | Directory listing | ✅ | Tool Reference |
calculateMath | Mathematical operations | ✅ | Tool Reference |
websearchGrounding | Google Vertex web search | ⚠️ Requires credentials | Tool Reference |
External MCP servers — connect any MCP-compliant server via neurolink mcp add; 11 popular servers (GitHub, PostgreSQL, Google Drive, Slack, and more) ship with ready-made configs:
MCP Transport Options:
| Transport | Use Case | Key Features |
|---|---|---|
stdio | Local servers | Command execution, environment variables |
http | Remote servers | URL-based, auth headers, retries, rate limiting |
sse | Event streams | Server-Sent Events, real-time updates |
websocket | Bi-directional | Full-duplex communication |
📖 MCP Integration Guide - Setup external servers 📖 HTTP Transport Guide - Remote MCP server configuration
Production-grade MCP capabilities for managing tool calls at scale across multi-server environments:
| Module | Purpose |
|---|---|
| Tool Router | Intelligent routing across servers with 6 strategies |
| Tool Cache | Result caching with LRU, FIFO, and LFU eviction |
| Request Batcher | Automatic batching of tool calls for throughput |
| Tool Annotations | Safety metadata and behavior hints for MCP tools |
| Tool Converter | Bidirectional conversion between NeuroLink and MCP formats |
| Elicitation Protocol | Interactive user input during tool execution (HITL) |
| Multi-Server Manager | Load balancing and failover across server groups |
| MCP Server Base | Abstract base class for building custom MCP servers |
| Enhanced Tool Discovery | Advanced search and filtering across servers |
| Agent & Workflow Exposure | Expose agents and workflows as MCP tools |
| Server Capabilities | Resource and prompt management per MCP spec |
| Registry Client | Discover and connect to MCP servers from registries |
| Tool Integration | End-to-end tool lifecycle with middleware chain |
| Elicitation Manager | Manages elicitation flows with validation and timeouts |
📖 MCP Enhancements Guide - Full reference for all 14 modules
SDK-First Design with TypeScript, IntelliSense, and type safety:
| Feature | Description | Documentation |
|---|---|---|
| Auto Provider Selection | Intelligent provider fallback | SDK Guide |
| Streaming Responses | Real-time token streaming | Streaming Guide |
| Conversation Memory | Automatic context management with embedded per-user memory | Memory Guide |
| Full Type Safety | Complete TypeScript types | Type Reference |
| Error Handling | Graceful provider fallback | Error Guide |
| Analytics & Evaluation | Usage tracking, quality scores | Analytics Guide |
| Middleware System | Request/response hooks | Middleware Guide |
| Framework Integration | Next.js, SvelteKit, Express | Framework Guides |
| Extended Thinking | Native thinking/reasoning mode for Gemini 3 and Claude models | Thinking Guide |
| RAG Document Processing | rag: { files } on generate/stream with 10 chunking strategies and hybrid search | RAG Guide |
17+ file categories supported (50+ total file types including code languages) with intelligent content extraction and provider-agnostic processing:
| Category | Supported Types | Processing |
|---|---|---|
| Documents | Excel (.xlsx, .xls), Word (.docx), PowerPoint (.pptx), RTF, OpenDocument | Sheet extraction, text extraction, slide + speaker-notes extraction |
| Data | JSON, YAML, XML | Validation, syntax highlighting |
| Markup | HTML, SVG, Markdown, Text | OWASP-compliant sanitization |
| Code | 50+ languages (TypeScript, Python, Java, Go, etc.) | Language detection, syntax metadata |
| Config | .env, .ini, .toml, .cfg | Secure parsing |
| Media | Images (PNG, JPEG, WebP, GIF), PDFs, CSV | Provider-specific formatting |
| Audio | .mp3, .wav, .m4a, .ogg, .flac, .webm | Automatic transcription + duration metadata |
| Video | .mp4, .webm, .mov, .mkv, .avi | Keyframe extraction, metadata, embedded subtitles |
Audio and video attach the same way. Audio is transcribed automatically before the model sees it; video is reduced to keyframes plus metadata and any embedded subtitle track:
Audio transcription needs a provider with a speech model configured (OpenAI Whisper by default). Video keyframe extraction requires
ffmpeg— install it separately or rely on the bundledffmpeg-static.
Key Features:
📖 File Processors Guide - Complete reference for all file types
Capabilities for regulated industries:
| Feature | Description | Use Case | Documentation |
|---|---|---|---|
| Enterprise Proxy | Corporate proxy support | Behind firewalls | Proxy Setup |
| Redis Memory | Distributed conversation state | Multi-instance deployment | Redis Guide |
| Memory | Per-user condensed memory (S3/Redis/SQLite) | Long-term user context | Memory Guide |
| Cost Optimization | Automatic cheapest model selection | Budget control | Cost Guide |
| Multi-Provider Failover | Automatic provider switching | High availability | Failover Guide |
| Telemetry & Monitoring | OpenTelemetry integration | Observability | Telemetry Guide |
| Security Hardening | Credential management, auditing | Compliance | Security Guide |
| Custom Model Hosting | SageMaker integration | Private models | SageMaker Guide |
| Load Balancing | LiteLLM proxy integration | Scale & routing | Load Balancing |
Security & Compliance:
📖 Enterprise Deployment Guide - Complete production checklist
Distributed conversation state for multi-instance deployments:
| Feature | Description | Benefit |
|---|---|---|
| Distributed Memory | Share conversation context across instances | Horizontal scaling |
| Session Export | Export full history as JSON | Analytics, debugging, audit |
| Auto-Detection | Automatic Redis discovery from environment | Zero-config in containers |
| Graceful Failover | Falls back to in-memory if Redis unavailable | High availability |
| TTL Management | Configurable session expiration | Memory management |
Redis Setup Guide | Production Configuration | Migration Patterns
15+ commands for every workflow:
| Command | Purpose | Example | Documentation |
|---|---|---|---|
setup | Interactive provider configuration | neurolink setup | Setup Guide |
generate | Text generation | neurolink gen "Hello" | Generate |
stream | Streaming generation | neurolink stream "Story" | Stream |
status | Provider health check | neurolink status | Status |
loop | Interactive session | neurolink loop | Loop |
mcp | MCP server management | neurolink mcp discover | MCP CLI |
models | Model listing | neurolink models | Models |
eval | Model evaluation | neurolink eval | Eval |
serve | Start HTTP server in foreground mode | neurolink serve | Serve |
server start | Start HTTP server in background mode | neurolink server start | Server |
server stop | Stop running background server | neurolink server stop | Server |
server status | Show server status information | neurolink server status | Server |
server routes | List all registered API routes | neurolink server routes | Server |
server config | View or modify server configuration | neurolink server config | Server |
server openapi | Generate OpenAPI specification | neurolink server openapi | Server |
rag chunk | Chunk documents for RAG | neurolink rag chunk f.md | RAG CLI |
RAG flags are available on generate and stream: --rag-files, --rag-strategy, --rag-chunk-size, --rag-chunk-overlap, --rag-top-k
📖 Complete CLI Reference - All commands and options
Run AI-powered workflows directly in GitHub Actions with 30+ provider support and automatic PR/issue commenting.
| Feature | Description |
|---|---|
| Multi-Provider | 30+ providers with unified interface |
| PR/Issue Comments | Auto-post AI responses with intelligent updates |
| Multimodal Support | Attach images, PDFs, CSVs, Excel, Word, JSON, YAML, XML, HTML, SVG, code files to prompts |
| Cost Tracking | Built-in analytics and quality evaluation |
| Extended Thinking | Deep reasoning with thinking tokens |
📖 GitHub Action Guide - Complete setup and examples
NeuroLink features intelligent model selection and cost optimization:
NeuroLink's CLI goes beyond simple commands - it's a full AI development environment:
| Feature | Traditional CLI | NeuroLink Interactive |
|---|---|---|
| Session State | None | Full persistence |
| Memory | Per-command | Conversation-aware |
| Configuration | Flags per command | /set persists across session |
| Tool Testing | Manual per tool | Live discovery & testing |
| Streaming | Optional | Real-time default |
| Command | Purpose |
|---|---|
/set <key> <value> | Persist configuration (provider, model, temperature) |
/mcp discover | List all available MCP tools |
/export json | Export conversation to JSON |
/history | View conversation history |
/clear | Clear context while keeping settings |
Interactive CLI Guide | CLI Reference
Skip the wizard and configure manually? See docs/getting-started/provider-setup.md.
neurolink CLI mirrors the SDK so teams can script experiments and codify them later.
Full command and API breakdown lives in docs/cli/commands.md and docs/sdk/api-reference.md.
| Capability | Highlights |
|---|---|
| Provider unification | 30+ providers with automatic fallback, cost-aware routing, providerFallback policy, modelChain config. |
| Multimodal pipeline | Stream images + CSV data + PDF documents across providers with local/remote assets. Auto-detection for mixed file types. |
| Voice pipeline | TTS (6 providers: Google, OpenAI, ElevenLabs, Azure, Fish Audio, Cartesia) + STT (4 providers) + realtime voice APIs (OpenAI Realtime, Gemini Live). |
| Quality & governance | Auto-evaluation engine (14 scorers), guardrails middleware, HITL workflows, audit logging. |
| Memory & context | Per-user condensed memory (S3/Redis/SQLite), Redis session export, 4-stage context compaction. |
| CLI tooling | Loop sessions, setup wizard, config validation, Redis auto-detect, JSON output, TTS/STT flags. |
| Enterprise ops | Claude proxy, OTLP observability, OpenObserve dashboard, regional routing, credential management. |
| Tool ecosystem | MCP auto discovery, HTTP/stdio/SSE/WebSocket transports, LiteLLM hub access, SageMaker custom deployment, web search. |
| Area | When to Use | Link |
|---|---|---|
| Getting started | Install, configure, run first prompt | docs/getting-started/index.md |
| Feature guides | Understand new functionality front-to-back | docs/features/index.md |
| CLI reference | Command syntax, flags, loop sessions | docs/cli/index.md |
| SDK reference | Classes, methods, options | docs/sdk/index.md |
| RAG | Document chunking, hybrid search, reranking, rag:{} API | docs/features/rag.md |
| Integrations | LiteLLM, SageMaker, MCP | docs/litellm-integration.md |
| Advanced | Middleware, architecture, streaming patterns | docs/advanced/index.md |
| Cookbook | Practical recipes for common patterns | docs/cookbook/index.md |
| Guides | Migration, Redis, troubleshooting, provider selection | docs/guides/index.md |
| Operations | Configuration, troubleshooting, provider matrix | docs/reference/index.md |
Enterprise Features:
Provider Intelligence:
Middleware System:
Redis & Persistence:
Migration Guides:
Developer Experience:
docs/litellm-integration.mddocs/sagemaker-integration.mddocs/enterprise-proxy-setup.mddocs/configuration-management.mddocs/advanced/mcp-integration.mddocs/mcp-http-transport.mddocs/development/contributing.mdNeuroLink is made possible by the vibrant open-source AI ecosystem. We gratefully acknowledge the teams behind OpenAI, Anthropic, Google AI, Mistral, and the many other providers and open-source projects that power this platform. Special thanks to every contributor who has filed issues, submitted pull requests, or shared feedback — your input drives NeuroLink forward.
NeuroLink is built with ❤️ by Juspay. Contributions, questions, and production feedback are always welcome.