Skip to main content
POST
/
memories
/
upload
JavaScript
import fs from 'fs';
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.upload({ file: fs.createReadStream('path/to/file') });

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.

Body

multipart/form-data
​
file
file
required

The file to ingest.

​
collection
string | null
deprecated

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

​
metadata
string | null

Custom metadata as JSON string for filtering. Keys must be alphanumeric with underscores, max 64 chars. Values must be string, number, or boolean.

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