Try our new Setup Skill to automatically integrate Hyperspell into your project
API Documentation
Memories
Messages
Traces
Authentication
Daemon
Integrations
Connections
Folder Policies
Vault
Context Documents
- POSTGenerate a context document
- GETPreview available data for context document generation
- GETList context documents
- GETGet a context document
- POSTGenerate context docs folder structure in Google Drive
- POSTGenerate a three-tier context document tree
- GETGet the latest context document tree
- POSTPublish a draft context document tree
- POSTPublish a specific tier of a context document tree
- PATCHEdit files in a draft tree before publishing
- GETDiff a tree against the previous published tree
- GETCheck staleness of context documents
import Hyperspell from '@hyperspell/hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
const memory = await client.memories.delete('resource_id', { source: 'reddit' });
console.log(memory.resource_id);{
"success": true,
"resource_id": "<string>",
"source": "reddit",
"chunks_deleted": 123,
"message": "<string>"
}Delete memory
Delete a memory and its associated chunks from the index.
This removes the memory completely from the vector index and database. The operation deletes:
- All chunks associated with the resource (including embeddings)
- The resource record itself
Args: source: The document provider (e.g., gmail, notion, vault) resource_id: The unique identifier of the resource to delete api_token: Authentication token
Returns: MemoryDeletionResponse with deletion details
Raises: DocumentNotFound: If the resource doesn’t exist or user doesn’t have access
import Hyperspell from '@hyperspell/hyperspell';
const client = new Hyperspell({
apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});
const memory = await client.memories.delete('resource_id', { source: 'reddit' });
console.log(memory.resource_id);{
"success": true,
"resource_id": "<string>",
"source": "reddit",
"chunks_deleted": 123,
"message": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.hyperspell.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.
Path Parameters
reddit, notion, slack, google_calendar, google_mail, box, dropbox, github, google_drive, vault, web_crawler, trace, microsoft_teams, gmail_actions Response
Successful Response
Was this page helpful?