|
| 1 | +--- |
| 2 | +title: HyperSpell |
| 3 | +description: Personal knowledge base for agents |
| 4 | +--- |
| 5 | + |
| 6 | +One integration, all the world's data. Hyperspell is the data platform that lets you build your AI-enabled apps faster. Let your users connect to dozens of services, and use Hyperspell's end-to-end data pipeline to get structured data with a single API call. |
| 7 | + |
| 8 | +## Description |
| 9 | + |
| 10 | +[HyperSpell](https://hyperspell.com) provides agents with the ability to build and query personal knowledge bases with: |
| 11 | + |
| 12 | +- Cross-Source Search across documents, emails, Notion, Gmail, and other integrations |
| 13 | + |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +```bash |
| 18 | +agentstack tools add hyperspell |
| 19 | +``` |
| 20 | + |
| 21 | +Set the environment variables in your project's `.env` file: |
| 22 | + |
| 23 | +```env |
| 24 | +HYPERSPELL_API_KEY=your_api_key_here |
| 25 | +HYPERSPELL_USER_ID=your_user_id_here |
| 26 | +``` |
| 27 | + |
| 28 | +Get your API key and user ID from the [HyperSpell Dashboard](https://app.hyperspell.com/dashboard). |
| 29 | + |
| 30 | +## Available Functions |
| 31 | + |
| 32 | +The HyperSpell tool provides three core functions for knowledge management: |
| 33 | + |
| 34 | +### `hyperspell_search(query, sources=None, answer=False, user_id=None)` |
| 35 | + |
| 36 | +Search across your HyperSpell knowledge base for relevant information. |
| 37 | + |
| 38 | +#### Parameters: |
| 39 | +- `query` (str): The search query to find relevant information |
| 40 | +- `sources` (str, optional): Comma-separated list of sources to search (e.g., "collections,notion,gmail") |
| 41 | +- `answer` (bool, optional): If True, returns a direct AI answer instead of just documents. Defaults to False |
| 42 | +- `user_id` (str, optional): User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var |
| 43 | + |
| 44 | + |
| 45 | +### `hyperspell_add_document(text, title=None, collection=None, user_id=None)` |
| 46 | + |
| 47 | +Add a text document to your HyperSpell knowledge base. |
| 48 | + |
| 49 | +#### Parameters: |
| 50 | +- `text` (str): The full text content to add |
| 51 | +- `title` (str, optional): Optional title for the document |
| 52 | +- `collection` (str, optional): Optional collection name to organize the document |
| 53 | +- `user_id` (str, optional): User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var |
| 54 | + |
| 55 | + |
| 56 | +### `hyperspell_upload_file(file_path, collection=None, user_id=None)` |
| 57 | + |
| 58 | +Upload a file (PDF, Word doc, spreadsheet, etc.) to your HyperSpell knowledge base. |
| 59 | + |
| 60 | +#### Parameters: |
| 61 | +- `file_path` (str): Path to the file to upload |
| 62 | +- `collection` (str, optional): Optional collection name to organize the document |
| 63 | +- `user_id` (str, optional): User ID to use for this request. Defaults to HYPERSPELL_USER_ID env var |
| 64 | + |
| 65 | + |
| 66 | +If no `user_id` is provided, the tool defaults to the `HYPERSPELL_USER_ID` environment variable. |
| 67 | + |
| 68 | +## Integration Sources |
| 69 | + |
| 70 | +HyperSpell can search across multiple integrated sources: |
| 71 | +- **collections**: Your uploaded documents and added text |
| 72 | +- **notion**: Connected Notion workspaces |
| 73 | +- **gmail**: Connected Gmail accounts |
| 74 | +- **and more**: Additional integrations available through the HyperSpell platform |
| 75 | + |
| 76 | +For detailed integration setup, visit the [HyperSpell documentation](https://docs.hyperspell.com). |
| 77 | + |
0 commit comments