Skip to main content
POST
/
memories
/
update
/
{source}
/
{resource_id}
JavaScript
import Hyperspell from '@hyperspell/hyperspell';

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

const memoryStatus = await client.memories.update('resource_id', { source: 'reddit' });

console.log(memoryStatus.resource_id);
{
  "resource_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperspell.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
source
enum<string>
required
Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
linear,
hubspot,
salesforce,
coda
​
resource_id
string
required

Body

application/json
​
text
default:{}

Full text of the document. If provided, the document will be re-indexed.

​
collection
default:{}
deprecated

The collection to move the document to — deprecated, set the collection using metadata instead.

​
title
default:{}

Title of the document.

​
date
default:{}

Date of the document for ranking and filtering.

​
metadata

Custom metadata for filtering. Keys must be alphanumeric with underscores, max 64 chars. Values must be string, number, boolean, or null. Will be merged with existing metadata.

Response

Successful Response

​
source
enum<string>
required
Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
linear,
hubspot,
salesforce,
coda
​
resource_id
string
required
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
pending_review,
skipped