Try our new Claude Code Skill [blocked] to automatically integrate Hyperspell into your project
import Hyperspell from 'hyperspell';
const client = new Hyperspell({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const memoryListResponse of client.memories.list()) {
console.log(memoryListResponse.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>"
}This endpoint allows you to paginate through all documents in the index. You can filter the documents by title, date, metadata, etc.
import Hyperspell from 'hyperspell';
const client = new Hyperspell({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const memoryListResponse of client.memories.list()) {
console.log(memoryListResponse.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>"
}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.
Filter documents by collection. Filter documents by collection.
Filter documents by source. Filter documents by source.
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 0 <= x <= 100Successful Response
Show child attributes
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 Show child attributes
pending, processing, completed, failed The relevance of the resource to the query
Was this page helpful?