Skip to main content

​
Description

Hyperspell provides agents created with AgentStack with the ability to build and query internal knowledge using:
  • Cross-source search across memories, emails, Notion, Gmail, Slack, and many other integrations
  • Upload files and documents to create your agents’ memory
  • Answering questions requiring multiple documents

​
Installation

agentstack tools add hyperspell
Create your Hyperspell app and get your API key from the Hyperspell Dashboard. Follow the instructions to connect your data sources Set the environment variables in your project’s .env file: 
HYPERSPELL_API_KEY=your_api_key_here
Hyperspell is a multi-tenant platform, and you can separate your data by use by setting the user id of your end-user in a variable too:
HYPERSPELL_USER_ID=your_user_id_here

​
Available Functions

The Hyperspell tool provides three core functions for knowledge retrieval and ingestion:

​
Query memories

hyperspell_search(query, sources, answer=False, user_id=None)
Search across your Hyperspell-connected sources for relevant information. Parameters:
​
query
string
required
The search query to find relevant information
​
sources
string
required
Comma-separated list of sources to search (e.g., collections,notion,gmail)
​
answer
bool
default:"False"
If True, returns a direct AI answer instead of just documents. Defaults to False
​
user_id
string
User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var

​
Add documents

hyperspell_add_document(text, title=None, collection=None, user_id=None)
Add a text document to your Hyperspell knowledge base. Parameters:
​
text
string
required
The full text content to add
​
title
string
required
Optional title for the document
​
collection
string
Optional collection name to organize the document
​
user_id
string
User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var

​
Upload files

hyperspell_upload_file(file_path, collection=None, user_id=None)
Upload a file (PDF, Word doc, spreadsheet, etc.) to your Hyperspell knowledge base. Parameters:
​
file_path
string
required
Path to the file to upload
​
collection
string
Optional collection name to organize the document
​
user_id
string
User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var
If no user_id is provided, the tool defaults to the HYPERSPELL_USER_ID environment variable.

​
Integration Sources

Hyperspell can search across multiple integrated sources:
  • collections: Your uploaded documents and added text
  • notion: Connected Notion workspaces
  • gmail: Connected Gmail accounts
  • slack: Connected Slack workspaces
  • and many more: Additional integrations available through the Hyperspell platform
For detailed integration setup, visit the Hyperspell documentation.
⌘I