Hyperspell

Authentication Type: API Key or JWT Token

Description: Add long-term memory to your AI applications. Store, retrieve, and manage documents, emails, call transcripts, and other text for semantic search and context retrieval.

Beta Tool: Please contact support to get this Beta tool added to your account.

Authentication

To authenticate, you'll need a Hyperspell API key from Hyperspell.

Use the Authorization: Bearer <api_key> header for authentication.

Optional: When using an API Key, set the X-As-User header to act as a specific user. JWT User Tokens are always scoped to a specific user.

Memories

Add Memory

Add a document to the memory index for later retrieval.

Operation Type: Mutation (Write)

Parameters:

• text string (required): Complete text of the document (text, email, call transcript, etc.)
• resource_id string (optional): Resource ID for the document. Generates new ID if omitted.
• collection string (optional): Collection name for easier retrieval
• title string (optional): Document title
• date string (optional): Document creation/update date (ISO 8601)
• metadata object (optional): Custom metadata for filtering
  • Keys: alphanumeric, max 64 characters
  • Values: string, number, or boolean

Returns:

• source string: Document provider
• resource_id string: Unique resource identifier
• status string: Processing status (pending, processing, completed, failed)

Example Usage:

{
  "text": "Meeting notes from Q4 planning session. Key decisions: 1. Launch new product in March 2. Increase marketing budget by 20% 3. Hire 5 new engineers",
  "collection": "meeting-notes",
  "title": "Q4 Planning Session",
  "date": "2024-01-15T14:00:00Z",
  "metadata": {
    "department": "product",
    "meeting_type": "planning",
    "quarter": "Q4"
  }
}

Update Memory

Update an existing document in the memory index.

Operation Type: Mutation (Write)

Parameters:

• source string (required): Document provider
• resource_id string (required): Resource ID to update
• text string (optional): Updated document text
• title string (optional): Updated title
• metadata object (optional): Updated metadata

Returns:

• source string: Document provider
• resource_id string: Resource identifier
• status string: Processing status

Get Memory

Retrieve a document by provider and resource ID.

Operation Type: Query (Read)

Parameters:

• source string (required): Document provider (collections, vault, web_crawler, notion, slack, google_calendar, etc.)
• resource_id string (required): Unique resource identifier

Returns:

• source string: Document provider
• resource_id string: Resource identifier
• title string (nullable): Document title
• metadata object: Document metadata
  • created_at string: Creation timestamp
  • indexed_at string: Indexing timestamp
  • last_modified string: Last modification timestamp
  • status string: Processing status (pending, processing, completed, failed)
  • events array: Processing event log
  • url string (nullable): Source URL if applicable
• score number (nullable): Relevance score if from search

Example Usage:

{
  "source": "collections",
  "resource_id": "doc_abc123xyz"
}

Common Use Cases

AI Assistants:

• Give AI assistants access to historical conversations
• Store and retrieve user preferences and context
• Build personalized AI experiences with memory

Knowledge Management:

• Index meeting notes, documents, and emails
• Enable semantic search across organizational knowledge
• Retrieve relevant context for AI-powered answers

Call Analytics:

• Store call transcripts for later analysis
• Search across historical conversations
• Extract insights from customer interactions

Document Processing:

• Index documents for semantic retrieval
• Build RAG (Retrieval Augmented Generation) systems
• Power AI search across large document collections