Retrieval Augmented Generation

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

Authentication

Use Clerk to manage your users and their data

Clerk

Agentic Computing

An overview of Hyperspell's security features and practices.

Security

Available Integrations

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

Scrape URL

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

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

Get Document

Add Collection

Get Collection

Lists all collections the user has access to.

List Collections

Query the index with natural language

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

Get Started

Usage

Resources

Retrieval Augmented Generation