Supermemory

App · 20 actions

Store documents, search memories, and read profiles from Supermemory.

Actions

ActionWhat it does
Add documentAdd document in Supermemory.
Add documentsAdd documents in Supermemory.
Count document memoriesCount document memories in Supermemory.
Delete documentsDelete documents in Supermemory.
Delete profile bucketsDelete profile buckets in Supermemory.
Forget memoriesForget memories in Supermemory.
Get connectorRetrieve connector from Supermemory.
Get documentRetrieve document from Supermemory.
Get memoryRetrieve memory from Supermemory.
Get namespaceRetrieve namespace from Supermemory.
Get organizationRetrieve organization from Supermemory.
Get profileRetrieve profile from Supermemory.
List connectorsRetrieve a page of connectors from Supermemory.
List documentsRetrieve a page of documents from Supermemory.
List namespacesRetrieve a page of namespaces from Supermemory.
List profile bucketsRetrieve a page of profile buckets from Supermemory.
Search memoriesSearch memories in Supermemory.
Sync connectorSync connector in Supermemory.
Update documentUpdate document in Supermemory.
Update namespaceUpdate namespace in Supermemory.

Add document

Add document in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
ContentcontenttextRequired
The content to process. This may be plaintext or a URL to supported rich content.
Record IDrecord_idtext
An optional caller-defined document ID.
Supporting contextsupporting_contexttext
Context used to guide memory extraction within this namespace. Max 1500 characters.
Metadatametadataobject
Arbitrary metadata attached to the document and derived data.
Groupgroupobject
Metadata values that isolate related context within the namespace.
Datedatetext
When the source content is from, in ISO 8601 format.
Task typetask_typetext
Processing pipeline. "memory" builds durable learned context; "superrag" optimizes the document for retrieval without generating memories.One of: memory, superrag.
Dreamingdreamingtext
Dreaming.One of: dynamic, instant.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "id": "example",
    "status": "unknown"
  }
}

Add documents

Add documents in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
DocumentsdocumentslistRequired
Documents to ingest or append in one request.
Task typetask_typetext
Processing pipeline. "memory" builds durable learned context; "superrag" optimizes the document for retrieval without generating memories.One of: memory, superrag.
Dreamingdreamingtext
Dreaming.One of: dynamic, instant.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "count": 1,
    "failed": 1,
    "results": []
  }
}

Count document memories

Count document memories in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
IdsidslistRequired
Ids.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "counts": []
  }
}

Delete documents

Delete documents in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
IdsidslistRequired
Document identifiers to permanently delete from this namespace.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "count": 1,
    "errors": []
  }
}

Delete profile buckets

Delete profile buckets in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace to search. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.
BucketsbucketslistRequired
Namespace-owned bucket names to delete. Organization-level buckets are protected and cannot be removed here.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "buckets": {}
  }
}

Forget memories

Forget memories in Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace containing the memories to forget. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.
IdsidslistRequired
Memory identifiers to remove from normal recall.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "count": 1,
    "errors": [],
    "matches": []
  }
}

Get connector

Retrieve connector from Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.
Connector IDconnector_idtextRequired
Connector identifier returned when the connector was created.
Includeincludelist
Comma-separated extras. syncs: the 10 most recent sync runs with their failed items. picker: a one-time hosted picker URL.One or more of: syncs, picker.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "account": "example",
    "authorization": {
      "expiresAt": "example",
      "url": "example"
    },
    "capabilities": {
      "selectable": false,
      "webhooks": false
    },
    "config": {},
    "documentCount": 1.0,
    "documentLimit": 1.0,
    "id": "example",
    "latestRun": {},
    "namespace": "example",
    "picker": {},
    "provider": "notion",
    "selection": {},
    "syncs": [],
    "system": {
      "createdAt": "example",
      "lastSuccessfulSyncAt": "example",
      "status": "pending_authorization"
    }
  }
}

Get document

Retrieve document from Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
Document IDdocument_idtextRequired
The public document ID.
Includeincludelist
Comma-separated child resources to include: chunks, memories, or both.One or more of: chunks, memories.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "chunks": [],
    "content": "example",
    "id": "example",
    "memories": [],
    "metadata": {},
    "summary": "example",
    "system": {
      "createdAt": "example",
      "dreamingStatus": "dreaming",
      "source": "example",
      "status": "unknown",
      "updatedAt": "example"
    },
    "title": "example",
    "type": "example"
  }
}

Get memory

Retrieve memory from Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace containing the memories to forget. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.
Memory IDmemory_idtextRequired
Memory identifier.
Includeincludelist
Comma-separated extras. related: the memory's version history and connected memories. documents: the source document, also attached to each related memory when both are requested.One or more of: related, documents.
Related limitrelated_limitnumber
Related limit.From 1 to 100.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "id": "example",
    "included": {
      "document": {
        "id": "example",
        "metadata": {},
        "summary": "example",
        "system": {
          "createdAt": "example",
          "updatedAt": "example"
        },
        "title": "example",
        "type": "example"
      },
      "related": {
        "children": [],
        "parents": [],
        "siblings": []
      }
    },
    "isForgotten": false,
    "isInference": false,
    "isLatest": false,
    "isStatic": false,
    "memory": "example",
    "metadata": {},
    "system": {
      "createdAt": "example",
      "updatedAt": "example"
    },
    "version": 1
  }
}

Get namespace

Retrieve namespace from Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "namespace": "example",
    "supportingContext": "example",
    "system": {
      "createdAt": "example",
      "updatedAt": "example"
    }
  }
}

Get organization

Retrieve organization from Supermemory.

Inputs

None.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "namespaceCount": 1,
    "organizationalContext": "example"
  }
}

Get profile

Retrieve profile from Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace to search. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.
Filterfiltertext
Type-safe metadata conditions that limit which memories contribute to the profile.
Bucketsbucketslist
Custom buckets to return. Omit to return every effective bucket.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "profile": {
      "buckets": {},
      "dynamic": [],
      "static": []
    }
  }
}

List connectors

Retrieve a page of connectors from Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.
Providerprovidertext
Only return connectors for this provider.One of: notion, google-drive, onedrive, gmail, github, web-crawler, s3, granola.
Pagepagenumber
One-based page number.From 1 to 9007199254740991.
Limitlimitnumber
Maximum connectors to return per page.From 1 to 100.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "connectors": [],
    "pagination": {
      "currentPage": 1.0,
      "hasMore": false,
      "limit": 1.0,
      "nextCursor": "example",
      "totalItems": 1.0,
      "totalPages": 1.0
    }
  }
}

List documents

Retrieve a page of documents from Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace containing the resources to list. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope resources.
Cursorcursortext
Cursor.
Limitlimitnumber
Maximum resources to return per page.From 1 to 100.
Sortsorttext
Field used to order results. Position is available only when listing chunks.One of: createdAt, updatedAt, position.
Orderordertext
Ascending or descending sort direction.One of: asc, desc.
Filterfiltertext
Type-safe metadata conditions applied before pagination.
Includeincludeobject
Optional extras.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "documents": [],
    "pagination": {
      "currentPage": 1.0,
      "hasMore": false,
      "limit": 1.0,
      "nextCursor": "example",
      "totalItems": 1.0,
      "totalPages": 1.0
    }
  }
}

List namespaces

Retrieve a page of namespaces from Supermemory.

Inputs

Pagepagenumber
One-based page number.From 1 to 9007199254740991.
Limitlimitnumber
Maximum namespaces to return per page.From 1 to 100.
Qqtext
Case-insensitive substring to match against namespace names.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "namespaces": [],
    "pagination": {
      "currentPage": 1.0,
      "hasMore": false,
      "limit": 1.0,
      "nextCursor": "example",
      "totalItems": 1.0,
      "totalPages": 1.0
    }
  }
}

List profile buckets

Retrieve a page of profile buckets from Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace to search. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "buckets": {}
  }
}

Search memories

Search memories in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace to search. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.
QueryquerytextRequired
Natural-language question, topic, or phrase to retrieve relevant context for. Replaces the v4 `q` field.
Filterfiltertext
Type-safe metadata conditions applied before ranking results. Replaces the v4 `filters` field and unifies both legacy filter formats into one expression type.
Search modesearch_modetext
Search surface. "hybrid" combines learned memories with source chunks, "memories" returns learned context, and "chunks" returns source passages.One of: hybrid, memories, chunks.
Limitlimitnumber
Maximum number of results to return.From 1 to 100.
Includeincludeobject
Optional context to include alongside each matching result.
Thresholdthresholdnumber
Minimum relevance score from 0 to 1. Raise it for precision (fewer, accurate results) or lower it for broader recall (more results).From 0 to 1.
Rerankreranktext
Rerank.One of: none, order, aggregate.
Rewrite queryrewrite_querytrue/false
Expand and clarify the query before retrieval to improve recall for conversational or underspecified prompts. This increases the latency by about 400ms.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "results": [],
    "searchTime": 1.0
  }
}

Sync connector

Sync connector in Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.
Connector IDconnector_idtextRequired
Connector identifier returned when the connector was created.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "id": "example",
    "status": "example"
  }
}

Update document

Update document in Supermemory.

Inputs

NamespacenamespacetextRequired
The isolated namespace. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents.
Document IDdocument_idtextRequired
The public document ID.
Contentcontenttext
The content to process. This may be plaintext or a URL to supported rich content.
Supporting contextsupporting_contexttext
Context used to guide memory extraction within this namespace. Max 1500 characters.
Metadatametadataobject
Arbitrary metadata attached to the document and derived data.
Groupgroupobject
Metadata values that isolate related context within the namespace.
Datedatetext
When the source content is from, in ISO 8601 format.
Task typetask_typetext
Processing pipeline. "memory" builds durable learned context; "superrag" optimizes the document for retrieval without generating memories.One of: memory, superrag.
Dreamingdreamingtext
Dreaming.One of: dynamic, instant.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "id": "example",
    "status": "unknown"
  }
}

Update namespace

Update namespace in Supermemory.

Inputs

NamespacenamespacetextRequired
Namespace identifier. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope documents and memories.
Supporting contextsupporting_contexttext
Background that guides how Supermemory interprets documents and forms memories. Max 1500 characters. Set null to clear it.

Outputs

dataobject
The result returned by Supermemory.
Example output
{
  "data": {
    "namespace": "example",
    "supportingContext": "example",
    "system": {
      "createdAt": "example",
      "updatedAt": "example"
    }
  }
}

On this page