GET
/
memories
/
list
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: 'My API Key',
});

// 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>",
      "metadata": {
        "indexed_at": "2023-11-07T05:31:56Z",
        "last_modified": "2023-11-07T05:31:56Z",
        "status": "pending",
        "events": [
          {
            "message": "<string>",
            "time": "2023-11-07T05:31:56Z",
            "type": "error"
          }
        ]
      },
      "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,
vault,
web_crawler,
notion,
slack,
google_calendar,
reddit,
box,
google_drive,
airtable,
algolia,
amplitude,
asana,
ashby,
bamboohr,
basecamp,
bubbles,
calendly,
confluence,
clickup,
datadog,
deel,
discord,
dropbox,
exa,
facebook,
front,
github,
gitlab,
google_docs,
google_mail,
google_sheet,
hubspot,
jira,
linear,
microsoft_teams,
mixpanel,
monday,
outlook,
perplexity,
rippling,
salesforce,
segment,
todoist,
twitter,
zoom
​
cursor
string | null
​
size
integer
default:50
Required range: 0 <= x <= 100

Response

200
application/json

Successful Response

The response is of type object.