Get memory
Retrieve a document by provider and resource ID, including its full hyperdoc tree.
Authorizations
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.
Headers
Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token
Path Parameters
reddit, notion, slack, google_calendar, google_mail, imap, google_meet, box, dropbox, github, gitlab, google_drive, vault, web_crawler, trace, microsoft_outlook, microsoft_teams, granola, fathom, fireflies, figma, linear, hubspot, salesforce, coda, confluence, jira, metabase, gong, clickup, lightfield, pylon, fellow, odoo, external_mcp Response
Successful Response
A document-shaped API response containing the hyperdoc tree.
reddit, notion, slack, google_calendar, google_mail, imap, google_meet, box, dropbox, github, gitlab, google_drive, vault, web_crawler, trace, microsoft_outlook, microsoft_teams, granola, fathom, fireflies, figma, linear, hubspot, salesforce, coda, confluence, jira, metabase, gong, clickup, lightfield, pylon, fellow, odoo, external_mcp Hyperdoc document type discriminator (document, message, file, event, ...).
The full hyperdoc tree. Switch on type for the document frame and recurse through children for the body.
Human-readable document title.
Indexing status of the document.
pending, processing, completed, failed, pending_review, skipped, filtered, cancelled The document's collection, if any.
Filterable custom metadata attached to the document.
When Hyperspell first indexed the document.
When the source document was last modified, if supplied by the source.
The document's own date (e.g. email sent date, event date).