.mint-text-emerald-600 {
    --tw-text-opacity: 1;
    color: rgb(5 150 105 / var(--tw-text-opacity))
}
.mint-text-sky-600 {
    --tw-text-opacity: 1;
    color: rgb(2 132 199 / var(--tw-text-opacity))
}

Overview

Authentication

Search through Deel contractor and payroll data

Deel

Hyperspell

Introduction

Quickstart

Allow your users to connect their accounts to Hyperspell

Core Concepts

Query your users' data using natural language

Integration

Learn how to authorize requests to the Hyperspell API

Let your users connect their accounts to Hyperspell to automatically index data

Hyperspell Connect

Hyperspell's MCP server lets you easily connect Claude, ChatGPT and other AI apps to your data.

Model Context Protocol

Use third-party authentication services like Clerk to manage your users and their data

Third-party authentication

Changelog

An overview of Hyperspell's security features and practices.

Security

Available Integrations

Search through Airtable bases and records

Airtable

Algolia

Amplitude

Asana

Ashby

BambooHR

Search through Basecamp projects and discussions

Basecamp

Search through Calendly events and scheduling data

Calendly

Search through ClickUp tasks and projects

ClickUp

Upload and search through files manually added to Hyperspell

Hyperspell Collections

Datadog

Search through Discord messages and channels

Discord

Dropbox

Search through the web using Exa's neural search

Search through Facebook posts and conversations

Facebook

Search through Front conversations and messages

Front

Search through GitHub repositories and code

GitHub

Search through GitLab repositories and code

GitLab

Find events in your user's Google Calendar

Google Calendar

Google Docs

Search through Google Drive files and folders

Google Drive

GMail

Google Sheets

Search through HubSpot contacts, companies, and deals

HubSpot

Jira

Search through Linear issues and projects

Linear

Mixpanel

Monday

Notion

Search through Outlook emails and calendar events

Microsoft Outlook

Search and query information using Perplexity's AI-powered search

Perplexity

Reddit

Search through Rippling employee and HR data

Rippling

Search through Salesforce records and data

Salesforce

Segment

Slack

Search through Todoist tasks and projects

Todoist

Search through X (Twitter) tweets and conversations

X (Twitter)

Web Crawler

Search through Zoom meetings and recordings

Zoom

Query your customers data and manually add data to your index

API Introduction

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.

Upload Text

This endpoint will upload a file to the index and return a document ID.
The file will be processed in the background and the document will be available for querying once the processing is complete.
You can use the `document_id` to query the document later, and check the status of the document.

Upload File

This endpoint allows you to paginate through all documents in the index.
You can filter the documents by title, date, metadata, etc.

List Documents

This endpoint shows the indexing progress of documents, both by provider and total.

Show indexing progress

Retrieves a document by provider and resource_id.

Get Document

Retrieves a document by its resource_id (deprecated — use /documents/get/{source}/{resource_id} instead).

Query the index with natural language

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 a user token

Get Basic user data

Revokes Hyperspell's access the given provider and deletes all stored credentials. It does not delete any cached or synced data.

Revoke an integration

List available calendars for a user. This can be used to ie. populate a dropdown for the user to select a calendar.

List available calendars

Recursively crawl a website to make it available for indexed search.

Crawl a website for indexed search

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.

Scrape URL

Retrieves a document by ID, including its collection name and sections.

Add Collection

Get Collection

Lists all collections the user has access to.

List Collections

Use this endpoing to create a user token for a specific user.
This token can be safely passed to your user-facing front-end.

Integrations

​Overview

​Authentication

Overview

Authentication