n8n-nodes-hyperspell
v0.3.0
Published
n8n community node for Hyperspell — add documents, semantic search, and AI-grounded answers from any workflow.
Maintainers
Readme
n8n-nodes-hyperspell
An n8n community node for Hyperspell — add documents, run semantic search, generate grounded answers, and query connected sources live from any workflow.
Hyperspell is the memory layer for your business: it unifies everything a company knows — across Slack, email, drive, CRM, and more — and makes it instantly queryable by people and AI agents.
Installation
Follow the n8n community node installation guide.
In short, in your n8n instance: Settings → Community Nodes → Install and enter n8n-nodes-hyperspell.
Credentials
You'll need a Hyperspell API key. Create one at app.hyperspell.com under Settings → API Keys.
The credential takes three fields:
- API Key — your Hyperspell API key (sent as
Authorization: Bearer …) - Act as User — optional user ID (sent as
X-As-User). An API key alone is scoped to the app; set this to query a specific user's documents and connected sources. Required for Live operations. - Base URL — defaults to
https://api.hyperspell.com. Override only for self-hosted Hyperspell deployments.
Operations
The node exposes three resources with the following operations:
Document
| Operation | Description |
|---|---|
| Add | Index a document. Supply text, optional title, resourceId (upsert key), date, and metadata. |
| Get | Retrieve a single document by source + resourceId. |
| List | Paginate through indexed documents. Supports filters by source, status, and metadata (MongoDB-style). |
| Delete | Remove a document and its chunks. |
Search
| Operation | Description | |---|---| | Search | Return the top-ranked chunks for a query (semantic + lexical). | | Answer | Same query, but Hyperspell also generates a grounded answer with citations. |
Live
Query a user's connected sources (Slack, Notion, HubSpot, …) directly — useful for data that isn't indexed yet. Live operations act on a specific user's connections, so set Act as User in the credential.
| Operation | Description | |---|---| | List Sources | List the user's connected sources and the live capabilities each supports. | | Search | Search a connected source live (where the source supports it). | | Get Resource | Fetch a single resource live by ID, optionally queueing it for indexing. | | List Resources | Paginate through a source's resources live (cursor-based). |
Use as an AI Agent tool
This node sets usableAsTool: true, so n8n's Tools Agent can invoke any operation directly. Connect the Hyperspell node as a Tool input on an Agent node and the LLM will call Search / Answer whenever it needs grounded context.
Example workflow
A common pattern:
- Trigger (Schedule, Webhook, anything) →
- HTTP Request / Slack / Gmail to fetch content →
- Hyperspell — Document → Add to index it →
- Later: Hyperspell — Search → Answer to query the index from chat / another workflow.
Development
To hack on this node locally, see CONTRIBUTING.md — it covers the two install paths (npm run dev hot-reload vs npm pack tarball install), how to mint a local Hyperspell API key, and the per-operation curl recipes for debugging routing.
