Skip to main content
GET
/
memories
/
list
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const memory of client.memories.list()) {
  console.log(memory.resource_id);
}
{
  "items": [
    {
      "source": "collections",
      "resource_id": "<string>",
      "title": "<string>",
      "metadata": {
        "created_at": "2023-11-07T05:31:56Z",
        "indexed_at": "2023-11-07T05:31:56Z",
        "last_modified": "2023-11-07T05:31:56Z",
        "status": "pending",
        "events": [
          {
            "message": "<string>",
            "type": "error",
            "time": "2023-11-07T05:31:56Z"
          }
        ],
        "url": "<string>"
      },
      "score": 123
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Query Parameters

collection
string | null

Filter documents by collection.

source
enum<string> | null

Filter documents by source.

Available options:
collections,
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
google_drive,
vault,
web_crawler
filter
string | null

Filter documents by metadata using MongoDB-style operators. Example: {"department": "engineering", "priority": {"$gt": 3}}

cursor
string | null
size
integer
default:50
Required range: 0 <= x <= 100

Response

Successful Response

items
Resource · object[]
required
next_cursor
string | null
required