Try our new Claude Code Skill to automatically integrate Hyperspell into your project
API Documentation
Memories
Authentication
Integrations
Connections
Vault
JavaScript
Copy
Ask AI
import Hyperspell from '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: 'collections' });
console.log(memory.resource_id);Copy
Ask AI
{
"success": true,
"resource_id": "<string>",
"source": "collections",
"chunks_deleted": 123,
"message": "<string>"
}Memories
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
DELETE
/
memories
/
delete
/
{source}
/
{resource_id}
JavaScript
Copy
Ask AI
import Hyperspell from '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: 'collections' });
console.log(memory.resource_id);Copy
Ask AI
{
"success": true,
"resource_id": "<string>",
"source": "collections",
"chunks_deleted": 123,
"message": "<string>"
}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
Available options:
collections, vault, web_crawler, notion, slack, google_calendar, reddit, box, google_drive, airtable, algolia, amplitude, asana, ashby, bamboohr, basecamp, bubbles, calendly, confluence, clickup, datadog, deel, discord, dropbox, exa, facebook, front, github, gitlab, google_docs, google_mail, google_sheet, hubspot, jira, linear, microsoft_teams, mixpanel, monday, outlook, perplexity, rippling, salesforce, segment, todoist, twitter, zoom Response
Successful Response
Available options:
collections, vault, web_crawler, notion, slack, google_calendar, reddit, box, google_drive, airtable, algolia, amplitude, asana, ashby, bamboohr, basecamp, bubbles, calendly, confluence, clickup, datadog, deel, discord, dropbox, exa, facebook, front, github, gitlab, google_docs, google_mail, google_sheet, hubspot, jira, linear, microsoft_teams, mixpanel, monday, outlook, perplexity, rippling, salesforce, segment, todoist, twitter, zoom Was this page helpful?
⌘I