Overview

The Vault integration allows you to upload and search through memories manually added to Hyperspell. It only supports .

Authentication

The Vault integration does not require any authentication and is available to all users.

Search Options

Following options are available for the options parameter of vault:

string

The collection to search through. If not provided, all collections will be searched.

Resources

The Vault integration returns Document resources:

Show Document Schema

string

required

The unique identifier of the page or database

string

required

The provider that fetched the document, which is set when the document is uploaded.

string

The title of the page

text

A summary of the document that can be fed directly into LLMs. When retrieved from the /query endpoint, this may summarize only the sections of the document returned as highlights (ie. parts relevant to your query). Otherwise, it will summarize the entire document.

elements[]

A structured representation of the page’s content. This field is only returned if the resource is returned from the /documents/get endpoint. If the website is returned from the /query endpoint, this field will be empty and the highlights field will contain the relevant sections of the website.

highlight[]

A list of highlights from the page relevant to the query. This field is only returned if the resource is returned from the /query endpoint.

​Overview

​Authentication

​Search Options

​Resources

Overview

Authentication

Search Options

Resources