Memories

List memories

Changed on

This endpoint allows you to paginate through all documents in the index. You can filter the documents by title, date, metadata, etc.

get/memories/list

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/memories/list
  • Auth
    HTTP bearer

Query parameters

collectionstring nullable

Filter documents by collection.

source'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' | 'page'

Filter documents by source.

status'pending' | 'processing' | 'completed' | 'failed' | 'pending_review' | 'skipped' | 'filtered' | 'cancelled'

Filter documents by status.

filterstring nullable

Filter documents by metadata using MongoDB-style operators. Example: {"department": "engineering", "priority": {"$gt": 3}}

include_chunksinteger

When > 0, include up to this many extracted memories (chunks with summaries) per document in each item's chunks field, in document order. 0 (default) omits them.

include_bodyboolean

Include document bodies where supported. Slack and Teams entries remain bounded envelopes; use GET /memories/get/{source}/{resource_id} for paginated channel content. File previews stay excluded. Other documents may include a bounded stored preview; use the same point read for larger content.

cursorstring nullable
sizeinteger

Headers

X-Hyperspell-Response-Profile'api' | 'mcp'

Response budget for the items array, including requested bodies: lowercase api scales with page size; lowercase mcp uses 256 KiB. Each record is limited to 32 KiB. Values are case-sensitive.

X-As-Userstring nullable

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

Response

Successful Response

next_cursorstring nullable required

Changes

  • 77d3e8d5e8a7Revision changes
    • warning

      added the new gong enum value to the // response property for the response status

    • info

      added the enum value gong to the property anyOf[subschema #1: DocumentProviders]/ of the query request parameter source

  • 455cd12eecb3Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status