# Hyperspell

## Docs

- [AgentStack](https://docs.hyperspell.com/advanced/agentstack.md)
- [Third-party authentication](https://docs.hyperspell.com/advanced/clerk.md): Use third-party authentication services like Clerk to manage your users and their data
- [Model Context Protocol](https://docs.hyperspell.com/advanced/mcp-overview.md): Hyperspell's MCP server lets you easily connect Claude, ChatGPT and other AI apps to your data.
- [Add a reaction](https://docs.hyperspell.com/api-reference/actions/add-a-reaction.md): Add an emoji reaction to a message on a connected integration.
- [Archive a message](https://docs.hyperspell.com/api-reference/actions/archive-a-message.md): Archive a Gmail message by removing the INBOX label.
- [Create an email draft](https://docs.hyperspell.com/api-reference/actions/create-an-email-draft.md): Create an email draft via a connected Gmail Actions integration.
- [Mark a message as read](https://docs.hyperspell.com/api-reference/actions/mark-a-message-as-read.md): Mark a Gmail message as read by removing the UNREAD label.
- [Mark a message as unread](https://docs.hyperspell.com/api-reference/actions/mark-a-message-as-unread.md): Mark a Gmail message as unread by adding the UNREAD label.
- [Modify message labels](https://docs.hyperspell.com/api-reference/actions/modify-message-labels.md): Modify labels on a Gmail message via a connected Gmail Actions integration.
- [Reply to an email thread](https://docs.hyperspell.com/api-reference/actions/reply-to-an-email-thread.md): Reply to an email thread via a connected Gmail Actions integration.
- [Send a message](https://docs.hyperspell.com/api-reference/actions/send-a-message.md): Send a message to a channel or conversation on a connected integration.
- [Send an email](https://docs.hyperspell.com/api-reference/actions/send-an-email.md): Send an email via a connected Gmail Actions integration.
- [Send an existing draft](https://docs.hyperspell.com/api-reference/actions/send-an-existing-draft.md): Send an existing email draft via a connected Gmail Actions integration.
- [Delete user](https://docs.hyperspell.com/api-reference/authentication/delete-user.md): Endpoint to delete user.
- [Get a user token](https://docs.hyperspell.com/api-reference/authentication/get-a-user-token.md): Use this endpoint to create a user token for a specific user. This token can be safely passed to your user-facing front-end.
- [Get Basic user data](https://docs.hyperspell.com/api-reference/authentication/get-basic-user-data.md): Endpoint to get basic user data.
- [List connections](https://docs.hyperspell.com/api-reference/connections/list-connections.md): List all connections for the user.
- [Revoke connection](https://docs.hyperspell.com/api-reference/connections/revoke-connection.md): Revokes Hyperspell's access the given provider and deletes all stored credentials and indexed data.
- [Check staleness of context documents](https://docs.hyperspell.com/api-reference/context-documents/check-staleness-of-context-documents.md): Check if context documents are stale — i.e., underlying sources have changed since the last tree was generated.
- [Diff a tree against the previous published tree](https://docs.hyperspell.com/api-reference/context-documents/diff-a-tree-against-the-previous-published-tree.md): Compute a diff between the given tree and the most recent published tree before it. Used by the knowledge manager to review what changed before publishing a draft.
- [Edit files in a draft tree before publishing](https://docs.hyperspell.com/api-reference/context-documents/edit-files-in-a-draft-tree-before-publishing.md): Edit individual files in a draft tree before publishing.
- [Generate a context document](https://docs.hyperspell.com/api-reference/context-documents/generate-a-context-document.md): Generate an LLM-synthesized context document from the app's synced data.
- [Generate a three-tier context document tree](https://docs.hyperspell.com/api-reference/context-documents/generate-a-three-tier-context-document-tree.md): Generate a three-tier context document tree for local push delivery.
- [Generate context docs folder structure in Google Drive](https://docs.hyperspell.com/api-reference/context-documents/generate-context-docs-folder-structure-in-google-drive.md): Generate context documents and write them to Google Drive.
- [Get a context document](https://docs.hyperspell.com/api-reference/context-documents/get-a-context-document.md): Get a specific context document by ID.
- [Get the latest context document tree](https://docs.hyperspell.com/api-reference/context-documents/get-the-latest-context-document-tree.md): Get the most recent context document tree for the authenticated app.
- [List context documents](https://docs.hyperspell.com/api-reference/context-documents/list-context-documents.md): List context documents for the authenticated app, most recent first.
- [Preview available data for context document generation](https://docs.hyperspell.com/api-reference/context-documents/preview-available-data-for-context-document-generation.md): Show what data is available before generating a context document.
- [Publish a draft context document tree](https://docs.hyperspell.com/api-reference/context-documents/publish-a-draft-context-document-tree.md): Publish a draft tree, making it available to the sync daemon.
- [Publish a specific tier of a context document tree](https://docs.hyperspell.com/api-reference/context-documents/publish-a-specific-tier-of-a-context-document-tree.md): Publish a single tier (company, team, skills, personal) of a draft tree.
- [Daemon Heartbeat](https://docs.hyperspell.com/api-reference/daemon/daemon-heartbeat.md): Record a daemon heartbeat. The dashboard reads these to show active daemons.
- [Device Approve](https://docs.hyperspell.com/api-reference/device-auth/device-approve.md): Approve a device code from the dashboard. Generates a daemon JWT.
- [Device Info](https://docs.hyperspell.com/api-reference/device-auth/device-info.md): Look up a device code to show the approval UI.
- [Device Login](https://docs.hyperspell.com/api-reference/device-auth/device-login.md): Start a device login flow. Returns a code the user enters in the dashboard.
- [Device Poll](https://docs.hyperspell.com/api-reference/device-auth/device-poll.md): Poll for device code approval. Returns a JWT when approved.
- [Delete emotional state](https://docs.hyperspell.com/api-reference/emotional-state/delete-emotional-state.md): Delete emotional state for the authenticated user.
- [Get latest emotional state](https://docs.hyperspell.com/api-reference/emotional-state/get-latest-emotional-state.md): Retrieve the most recent emotional state for the authenticated user.
- [Store emotional state](https://docs.hyperspell.com/api-reference/emotional-state/store-emotional-state.md): Store a conversation transcript as emotional state and trigger indexing.
- [Get query result](https://docs.hyperspell.com/api-reference/evaluation/get-query-result.md): Retrieve the result of a previous query.
- [Score a highlight](https://docs.hyperspell.com/api-reference/evaluation/score-a-highlight.md): Score an individual highlight.
- [Score a query result](https://docs.hyperspell.com/api-reference/evaluation/score-a-query-result.md): Score the result of a query.
- [Create a folder policy for a connection](https://docs.hyperspell.com/api-reference/folder-policies/create-a-folder-policy-for-a-connection.md): Create or update a folder policy for a specific connection.
- [Delete a folder policy](https://docs.hyperspell.com/api-reference/folder-policies/delete-a-folder-policy.md): Delete a folder policy for a specific connection.
- [List folder policies for a connection](https://docs.hyperspell.com/api-reference/folder-policies/list-folder-policies-for-a-connection.md): List all folder policies for a specific connection.
- [List folders for a connection](https://docs.hyperspell.com/api-reference/folders/list-folders-for-a-connection.md): List one level of folders from the user's connected source.
- [Check crawl status for a URL](https://docs.hyperspell.com/api-reference/integrations/check-crawl-status-for-a-url.md): Check whether a URL has been crawled and its current indexing status.
- [Crawl a website for indexed search](https://docs.hyperspell.com/api-reference/integrations/crawl-a-website-for-indexed-search.md): Recursively crawl a website to make it available for indexed search.
- [Link an integration](https://docs.hyperspell.com/api-reference/integrations/link-an-integration.md): Redirects to the connect URL to link an integration.
- [List all integrations](https://docs.hyperspell.com/api-reference/integrations/list-all-integrations.md): List all integrations for the user.
- [List available calendars](https://docs.hyperspell.com/api-reference/integrations/list-available-calendars.md): List available calendars for a user. This can be used to ie. populate a dropdown for the user to select a calendar.
- [List available Slack conversations](https://docs.hyperspell.com/api-reference/integrations/list-available-slack-conversations.md): List Slack conversations accessible to the user via the live Nango connection.
- [API Introduction](https://docs.hyperspell.com/api-reference/introduction.md): Query your customers data and manually add data to your index
- [Add a memory](https://docs.hyperspell.com/api-reference/memories/add-a-memory.md): Adds an arbitrary document to the index. This can be any text, email, call transcript, etc. The document will be processed and made available for querying once the processing is complete.
- [Add multiple memories](https://docs.hyperspell.com/api-reference/memories/add-multiple-memories.md): Adds multiple documents to the index in a single request.
- [Approve a pending resource](https://docs.hyperspell.com/api-reference/memories/approve-a-pending-resource.md): Approve a pending-review resource for indexing.
- [Delete memory](https://docs.hyperspell.com/api-reference/memories/delete-memory.md): Delete a memory and its associated chunks from the index.
- [Get memory](https://docs.hyperspell.com/api-reference/memories/get-memory.md): Retrieves a document by provider and resource_id.
- [List memories](https://docs.hyperspell.com/api-reference/memories/list-memories.md): This endpoint allows you to paginate through all documents in the index. You can filter the documents by title, date, metadata, etc.
- [Query memories](https://docs.hyperspell.com/api-reference/memories/query-memories.md): Retrieves documents matching the query.
- [Reject a pending resource](https://docs.hyperspell.com/api-reference/memories/reject-a-pending-resource.md): Reject a pending-review resource.
- [Show indexing progress](https://docs.hyperspell.com/api-reference/memories/show-indexing-progress.md): This endpoint shows the indexing progress of documents, both by provider and total.
- [Update a memory](https://docs.hyperspell.com/api-reference/memories/update-a-memory.md): Updates an existing document in the index. You can update the text, collection, title, and metadata. The document must already exist or a 404 will be returned. This works for documents from any source (vault, slack, gmail, etc.).
- [Upload a file](https://docs.hyperspell.com/api-reference/memories/upload-a-file.md): This endpoint will upload a file to the index and return a resource_id. The file will be processed in the background and the memory will be available for querying once the processing is complete. You can use the `resource_id` to query the memory later, and check the status of the memory.
- [Ingest messages](https://docs.hyperspell.com/api-reference/messages/ingest-messages.md): Ingest real-time messages for immediate full-text search.
- [Add an agent trace](https://docs.hyperspell.com/api-reference/traces/add-an-agent-trace.md): Add an agent trace/transcript to the index.
- [List vaults](https://docs.hyperspell.com/api-reference/vault/list-vaults.md): This endpoint lists all collections, and how many documents are in each collection. All documents that do not have a collection assigned are in the `null` collection.
- [Changelog](https://docs.hyperspell.com/concepts/changelog.md): New updates and improvements
- [Security](https://docs.hyperspell.com/concepts/security.md): An overview of Hyperspell's security features and practices.
- [Automatic Integration](https://docs.hyperspell.com/core/claude-code-skill.md): Use our setup skill to integrate Hyperspell into your codebase with any coding agent
- [Core Concepts](https://docs.hyperspell.com/core/concepts.md): Allow your users to connect their accounts to Hyperspell
- [Manual Integration](https://docs.hyperspell.com/core/integration.md): Query your users' data using natural language
- [Hyperspell Documentation](https://docs.hyperspell.com/core/introduction.md): Learn how to integrate Hyperspell, use our SDKs, and give your AI agents context and memory.
- [Quickstart](https://docs.hyperspell.com/core/quickstart.md): Start building AI apps on Hyperspell
- [Airtable](https://docs.hyperspell.com/integrations/all/airtable.md): Search through Airtable bases and records
- [Algolia](https://docs.hyperspell.com/integrations/all/algolia.md): Search through Algolia indices
- [Amplitude](https://docs.hyperspell.com/integrations/all/amplitude.md): Search through Amplitude analytics data
- [Asana](https://docs.hyperspell.com/integrations/all/asana.md): Search through Asana tasks and projects
- [Ashby](https://docs.hyperspell.com/integrations/all/ashby.md): Search through Ashby recruiting data
- [BambooHR](https://docs.hyperspell.com/integrations/all/bamboohr.md): Search through BambooHR employee data
- [Basecamp](https://docs.hyperspell.com/integrations/all/basecamp.md): Search through Basecamp projects and discussions
- [Box](https://docs.hyperspell.com/integrations/all/box.md): Search through Box files and folders
- [Calendly](https://docs.hyperspell.com/integrations/all/calendly.md): Search through Calendly events and scheduling data
- [ClickUp](https://docs.hyperspell.com/integrations/all/clickup.md): Search through ClickUp tasks and projects
- [Datadog](https://docs.hyperspell.com/integrations/all/datadog.md): Search through Datadog logs and metrics
- [Deel](https://docs.hyperspell.com/integrations/all/deel.md): Search through Deel contractor and payroll data
- [Discord](https://docs.hyperspell.com/integrations/all/discord.md): Search through Discord messages and channels
- [Dropbox](https://docs.hyperspell.com/integrations/all/dropbox.md): Search through Dropbox files and folders
- [Exa](https://docs.hyperspell.com/integrations/all/exa.md): Search through the web using Exa's neural search
- [Facebook](https://docs.hyperspell.com/integrations/all/facebook.md): Search through Facebook posts and conversations
- [Front](https://docs.hyperspell.com/integrations/all/front.md): Search through Front conversations and messages
- [GitHub](https://docs.hyperspell.com/integrations/all/github.md): Search through GitHub repositories and code
- [GitLab](https://docs.hyperspell.com/integrations/all/gitlab.md): Search through GitLab repositories and code
- [Google Calendar](https://docs.hyperspell.com/integrations/all/google_calendar.md): Find events in your user's Google Calendar
- [Google Docs](https://docs.hyperspell.com/integrations/all/google_docs.md): Search through Google Docs documents
- [Google Drive](https://docs.hyperspell.com/integrations/all/google_drive.md): Search through Google Drive files and folders
- [GMail](https://docs.hyperspell.com/integrations/all/google_mail.md): Query emails from GMail
- [Google Sheets](https://docs.hyperspell.com/integrations/all/google_sheet.md): Search through Google Sheets documents
- [HubSpot](https://docs.hyperspell.com/integrations/all/hubspot.md): Search through HubSpot contacts, companies, and deals
- [Jira](https://docs.hyperspell.com/integrations/all/jira.md): Search through Jira issues and projects
- [Linear](https://docs.hyperspell.com/integrations/all/linear.md): Search through Linear issues and projects
- [Mixpanel](https://docs.hyperspell.com/integrations/all/mixpanel.md): Search through Mixpanel analytics data
- [Monday](https://docs.hyperspell.com/integrations/all/monday.md): Search through Monday boards and items
- [Notion](https://docs.hyperspell.com/integrations/all/notion.md): Query Notion pages and databases
- [Microsoft Outlook](https://docs.hyperspell.com/integrations/all/outlook.md): Search through Outlook emails and calendar events
- [Perplexity](https://docs.hyperspell.com/integrations/all/perplexity.md): Search and query information using Perplexity's AI-powered search
- [Reddit](https://docs.hyperspell.com/integrations/all/reddit.md): Search reddit posts
- [Rippling](https://docs.hyperspell.com/integrations/all/rippling.md): Search through Rippling employee and HR data
- [Salesforce](https://docs.hyperspell.com/integrations/all/salesforce.md): Search through Salesforce records and data
- [Segment](https://docs.hyperspell.com/integrations/all/segment.md): Search through Segment customer data
- [Slack](https://docs.hyperspell.com/integrations/all/slack.md): Query Slack conversations and messages
- [Todoist](https://docs.hyperspell.com/integrations/all/todoist.md): Search through Todoist tasks and projects
- [X (Twitter)](https://docs.hyperspell.com/integrations/all/twitter.md): Search through X (Twitter) tweets and conversations
- [Vault](https://docs.hyperspell.com/integrations/all/vault.md): Upload and search through memories manually added to Hyperspell
- [Web Crawler](https://docs.hyperspell.com/integrations/all/web_crawler.md): Get answers from websites
- [Zoom](https://docs.hyperspell.com/integrations/all/zoom.md): Search through Zoom meetings and recordings
- [Available Integrations](https://docs.hyperspell.com/integrations/overview.md)
- [Hyperspell Connect](https://docs.hyperspell.com/usage/connect.md): Let your users connect their accounts to Hyperspell to automatically index data
- [Evaluation](https://docs.hyperspell.com/usage/evaluation.md): Score and evaluate your queries
- [Folder Sync](https://docs.hyperspell.com/usage/folder-sync.md): Control which folders are synced with per-folder policies
- [Custom Metadata](https://docs.hyperspell.com/usage/metadata.md): Add custom metadata to your memories and filter search results
- [Authentication](https://docs.hyperspell.com/usage/permissions.md): Learn how to authorize requests to the Hyperspell API
- [Procedural Memory](https://docs.hyperspell.com/usage/procedural-memory.md): Teach your agent how to perform tasks by learning from past sessions
- [Webhooks](https://docs.hyperspell.com/usage/webhooks.md): Get notified when users connect accounts and memories are indexed

## OpenAPI Specs

- [hyperspell](https://app.stainlessapi.com/api/spec/documented/hyperspell.yaml)