Skip to main content
Supermemory logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 86
  • Triggers: 0
  • Slug: SUPERMEMORY
  • Version: 20261101_00

Tools

Slug: SUPERMEMORY_ADD_DOCUMENTIngest text or a public URL as a Supermemory document and return its document ID and initial processing status.

Input Parameters

string
required
Plain text or a public URL to ingest.
string ("instant" | "dynamic")
Processing mode; instant processes this document alone and may consume an extra operation.
object
Flat metadata values: strings, numbers, booleans, or string arrays. Nested objects are not supported.
string
Caller-defined stable document ID for deduplication or lookup.
string ("memory" | "superrag")
Use memory for the full context layer or superrag for managed document retrieval.
string
Container tag used to isolate this document’s memories. Letters, numbers, underscores, colons, and hyphens only.
string
Context about the container entity that should guide memory extraction (maximum 1500 characters).
object
Flat metadata filter limiting existing memories used as ingestion context. Values may be strings, numbers, booleans, or string arrays.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_ADD_DOCUMENTSAdd 1 to 600 documents in one request, with per-document metadata and processing options. Inspect counts and results for partial failures; the tool raises an error if all documents fail, and the API does not guarantee atomicity or result ordering.

Input Parameters

string ("instant" | "dynamic")
Processing mode applied to the whole batch: dynamic groups related documents; instant processes documents independently and bills one extra operation per document.
array
required
One to 600 documents to ingest. Set each document’s optional processing fields explicitly when its behavior must differ from provider defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_ADD_NAMESPACE_DOCUMENTAdd text or a supported URL as searchable, evolving memory in an isolated namespace. Supply a new document ID to create a document, or reuse an existing ID to append information while preserving history. Ingestion is asynchronous: inspect the returned processing status and retrieve the document to check completion.

Input Parameters

string
Optional caller-defined document ID. A new ID creates a document; reusing an existing ID appends information while preserving history.
string
Optional source-content date in ISO 8601 format.
object
Optional metadata values isolating related context within the namespace; values may be strings, numbers, booleans, or string arrays.
string
required
Plain text or a URL to supported rich content to process.
string ("dynamic" | "instant")
Optional processing mode: dynamic (provider default) groups related documents; instant processes independently right away and bills one extra operation per document.
object
Optional flat document metadata with string, number, boolean, or string-array values; nested objects are not supported.
string
required
Isolated namespace for a user, project, or other context; at most 100 letters, digits, underscores, colons, or hyphens.
string ("memory" | "superrag")
Optional processing pipeline: memory builds durable learned context; superrag supports retrieval without generating memories.
string
Optional context guiding memory extraction within this namespace, up to 1500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_ADD_NAMESPACE_DOCUMENTSIngest 1 to 600 text or URL documents in an isolated namespace. Existing caller-defined IDs append information with single-document ingestion semantics. Acceptance is asynchronous, not completed processing. HTTP 200 may contain partial failures: inspect count, failed, and each result’s error, details, and url. Accepted results precede failures; match by id or failed-item url, not position. An all-failed batch raises an error.

Input Parameters

string ("dynamic" | "instant")
Batch processing mode: dynamic (provider default) groups related documents; instant processes independently and bills one extra operation per document.
string ("memory" | "superrag")
Batch processing pipeline: memory builds learned context; superrag optimizes retrieval without generating memories.
array
required
One to 600 documents to ingest or append.
string
required
Isolated user, project, or other namespace, up to 100 letters, digits, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_BULK_DELETE_DOCUMENTSDeprecated provider v3 endpoint; shuts down December 31, 2026. Use v5 namespace document deletion (DELETE /ns/{namespace}/document) instead. Delete up to 100 documents by ID, all documents in selected container tags, or documents matching a filepath. Container-tag and filepath selectors can delete many documents. Inspect success, deleted_count, and errors for the actual outcome; an HTTP 200 alone does not prove every document was deleted.

Input Parameters

array
One to 100 document IDs to delete.
string
Delete documents matching this filepath. Full paths match exactly; a trailing / selects a path prefix.
array
Deprecated selector: delete all documents in these containers. Each tag is at most 100 characters and uses letters, numbers, _, :, or - only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CONFIGURE_AUTOMATIC_TOPUPSDeprecated legacy v3 API, scheduled to shut down December 31, 2026. Configure automatic paid USD credit purchases for the connected organization. Enabling reloads can cause financial charges when the credit balance is low. Requires an unscoped organization API key with admin or owner access; paid-plan and saved-payment-method requirements apply when enabling. Supply the full console configuration explicitly, including when disabling. Purchase limits do not cap total usage or the full invoice.

Input Parameters

boolean
required
Whether to enable automatic paid credit top-ups.
number
required
USD credits to purchase per reload; the console minimum is 0.01.
number
required
USD balance threshold for automatic reloads; the console minimum is 0.
object
required
Explicit automatic purchase limit configuration. The console submits this object even when disabling reloads. No financial defaults are applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CONFIGURE_CONNECTIONDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Use the v5 namespace connectors API for new integrations. Configure selected resources for an existing legacy connection; currently only GitHub supports resource configuration. Returns the provider’s success flag, outcome message, and optional registered-webhook count.

Input Parameters

array
required
Resources selected for this connection, using the provider-defined resource objects returned by List Connection Resources. Currently supported for GitHub only; resource object fields are unrestricted in the provider schema.
string
required
ID of the existing connection to configure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_COUNT_NAMESPACE_DOCUMENT_MEMORIESCount live memories in a namespace for up to 100 public document IDs. Missing or inaccessible documents are omitted, not reported as zero.

Input Parameters

array
required
One to 100 public document IDs, each between 1 and 255 characters.
string
required
Isolated namespace identifying the user, project, or document scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CREATE_CONNECTIONDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use CREATE_CONNECTOR for v5 namespace-scoped connectors. Initialize a provider connection and return its ID and any authorization URL. This does not open the URL or complete user authorization; the user must authorize separately before the connection can import documents.

Input Parameters

object
Optional flat metadata with string, numeric, or boolean values; may explicitly be null.
string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
required
Provider for which to initialize a connection.
string
Optional URL to redirect the user to after provider authorization.
string
Optional container tag: up to 100 letters, numbers, underscores, colons, or hyphens.
array
Optional container tags, each up to 100 letters, numbers, underscores, colons, or hyphens.
integer
Optional maximum number of documents to import, from 1 to 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CREATE_CONNECTORConnect an external source to a namespace. Choose the provider-specific connector settings. OAuth providers return an authorization URL to send the user to; config-authenticated providers start syncing immediately.

Input Parameters

string
required
Provider-specific connector settings; provider selects the allowed config.
string
required
Namespace identifier scoping documents and memories, such as a user or project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CREATE_MEMORYDeprecated by the provider; v3/v4 APIs shut down on December 31, 2026. Use v5 namespace document ingestion for new integrations. Create 1 to 100 memories directly in an existing container, bypassing document ingestion. Generates embeddings and makes the memories immediately searchable.

Input Parameters

array
required
One to 100 memories to create directly.
string
required
Existing space’s container tag, up to 100 letters, digits, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_CREATE_SCOPED_KEYDeprecated legacy v3 route; provider shutdown is December 31, 2026. No v5 scoped-key creation alternative is documented. Create an API key restricted to one namespace or a fixed list of namespaces, using an organization API key; scoped keys cannot mint further keys. Writable scoped keys can update and delete content within their namespaces. Returns a secret credential: store it securely and do not log it.

Input Parameters

string
Key display name. If omitted, the provider defaults to scoped_{containerTag}.
string
Namespace for the key; required unless containerTags is supplied. Up to 100 letters, numbers, hyphens, underscores, or colons.
integer
Maximum requests per rate-limit window, from 1 to 10000. Provider default: 500.
array
Namespaces for the key. Takes precedence over containerTag when both are supplied.
integer
Optional key lifetime in days, from 1 to 365.
integer
Rate-limit window in milliseconds, from 1 to 3600000. Provider default: 60000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_CONNECTIONDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use DELETE_CONNECTOR for v5 namespace-scoped connector deletion instead. Delete a specific connection by ID. By default this also deletes documents imported by the connection; set deleteDocuments to ‘false’ to retain them. Returns deleted connection IDs and providers.

Input Parameters

string
required
ID of the connection to delete.
string
Whether to also delete documents imported by this connection. Defaults to the string ‘true’; pass ‘false’ to retain imported documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_CONNECTORDisconnect a connector in a namespace and stop its webhooks. Imported documents are also deleted by default. Set deleteDocuments to false to preserve those documents.

Input Parameters

string
required
Connector identifier returned when the connector was created.
string
required
Namespace identifying the user, project, or other connector scope.
boolean
Also delete documents imported by this connector. Defaults to true; set false to preserve imported documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_CONTAINER_TAGDeprecated by the provider: the legacy v3 API shuts down on December 31, 2026. Use v5 DELETE /ns/{namespace} to delete a namespace instead. Delete a container tag and all its documents and memories. Only organization owners and admins can perform this destructive action.

Input Parameters

string
required
Container tag to delete, together with all its documents and memories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_DOCUMENTPermanently delete one document by ID. This does not remove the document’s container-tag settings record.

Input Parameters

string
required
Supermemory document ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_NAMESPACERetire a namespace and permanently delete its documents and memories. Optionally set moveTo to preserve its content by moving everything into another namespace first. A queued response only acknowledges an asynchronous move, not completed deletion; a deleted response confirms permanent removal.

Input Parameters

string
Destination namespace receiving the content before deletion. Omit to permanently delete the content. Moves are asynchronous.
string
required
Namespace identifier to retire, such as a user or project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_NAMESPACE_DOCUMENTSPermanently delete 1 to 100 documents and their derived knowledge from a namespace by document ID or caller-defined ID. Each identifier is handled independently; successful deletions are preserved if others fail. Inspect count and every errors entry: HTTP 200 does not mean all documents were deleted.

Input Parameters

array
required
One to 100 document IDs or caller-defined IDs to permanently delete from this namespace. Each identifier is 1 to 255 characters.
string
required
Isolated namespace containing the documents, such as a user or project ID. At most 100 letters, numbers, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_NAMESPACE_PROFILE_BUCKETSRemove 1 to 50 profile bucket categories created specifically for a namespace and return its updated effective bucket definitions. Unknown names are safely ignored. Organization-wide buckets are protected and cannot be removed with this action. Requires namespace write access.

Input Parameters

array
required
One to 50 namespace-owned bucket slugs to delete. Each slug is 1 to 64 lowercase letters, digits, underscores, or hyphens, starting with a letter or digit. Organization-level buckets cannot be deleted here.
string
required
Isolated user or project namespace whose profile buckets to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_DELETE_PROVIDER_CONNECTIONDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use DELETE_CONNECTOR for v5 namespace-scoped connector deletion by connector ID instead. Delete connections for a specific provider and container tags. Returns the deleted connection IDs and providers.

Input Parameters

string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
required
Provider whose connections to delete.
array
required
Required array of container tags used to select connections for deletion. Each tag is at most 100 characters and contains only letters, numbers, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_FORGET_MATCHING_MEMORIESDeprecated by Supermemory: legacy v3/v4 APIs shut down December 31, 2026. Use v5 DELETE /ns/{namespace}/memories/semantic for semantic forgetting, or DELETE /ns/{namespace}/memories for exact IDs. Soft-delete memories in one container matching a natural-language instruction or exact IDs. Set dry_run=true to preview first; omission defaults to real forgetting. Semantic matches may change between preview and apply; use exact IDs for a reviewable selection.

Input Parameters

array
Exact memory IDs to forget without semantic search. Unknown IDs and IDs outside the container are ignored. Provide either ids or query.
string
Natural-language instruction or topic to forget. Provide either query or ids.
string
Optional reason stored as forgetReason on each forgotten memory.
boolean
Preview matching memories without mutation when true. Defaults to false, which forgets for real.
number
Minimum cosine similarity for semantic matches, from 0 to 1. Lower values match more broadly; default 0.5.
integer
Maximum memories this call may forget, from 1 to 500; default 100.
string
required
Container tag or space to which the forget operation is scoped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_FORGET_MEMORYDeprecated by the provider; v3/v4 APIs shut down on December 31, 2026. Use v5 DELETE /ns/{namespace}/memories for new integrations. Soft-delete a memory by ID or exact content within a required container tag. The memory is marked as forgotten, not permanently deleted.

Input Parameters

string
ID of the memory to forget. Provide this or an exact content match.
string
Optional reason for forgetting this memory.
string
Exact memory content to match when the memory ID is unavailable.
string
required
Required container tag scoping the operation; up to 100 letters, digits, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_FORGET_NAMESPACE_MEMORIESRemove 1 to 500 exact memories from normal recall in a namespace by stable memory ID, preserving their audit history. Each ID is handled independently: missing or ineligible memories are reported without rolling back successful changes. Inspect count, errors, and matches; HTTP 200 does not mean every requested memory was forgotten.

Input Parameters

array
required
One to 500 non-empty stable memory identifiers to remove from normal recall.
string
required
Namespace containing the memories to forget, such as a user or project ID. At most 100 letters, numbers, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_FORGET_NAMESPACE_MEMORIES_SEMANTICALLYPreview or forget memories in a namespace using a natural-language query. Explicitly set dryRun to true to preview or false to apply forgetting. For a reviewable, drift-free workflow, preview here and pass the returned memory IDs to the exact-ID forget action instead of rerunning the query. Inspect count, matches, and errors for the provider-reported outcome.

Input Parameters

string
required
Natural-language description of the memories that should be forgotten.
boolean
required
Required choice: true previews matching memories without changing their recall state; false applies forgetting to the matching set.
string
required
Namespace containing the memories to forget, such as a user or project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_ACCOUNT_STATUSReturn the connected Supermemory organization’s plan, credit balance, high-level usage, and reset date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_AUTOMATIC_TOPUPSDeprecated legacy v3 API, scheduled to shut down December 31, 2026. Get the connected organization’s automatic credit top-up configuration and payment-method availability without changing billing settings or purchasing credits. Requires an unscoped organization API key; scoped API keys cannot read billing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_BILLING_USAGEDeprecated legacy v3 API; provider shutdown is December 31, 2026. Retrieve the connected organization’s per-feature billing usage, limits, units, and period bounds when available. Requires an organization API key; scoped API keys cannot read billing. Console usage estimates are not authoritative invoices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_BILLING_USAGE_EVENTSDeprecated legacy v3 API, scheduled to shut down December 31, 2026. Get daily billing meter events for the connected organization, including per-feature consumption and Memory versus SuperRAG token totals. Optional ISO 8601 start and end override the billing period. Requires an organization API key; scoped API keys cannot read billing. Console usage is an estimate; invoice line items are authoritative.

Input Parameters

string
ISO 8601 end of the usage window; omit to use the billing period.
string
ISO 8601 start of the usage window; omit to use the billing period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_CONNECTIONDeprecated by the provider: this legacy v3 endpoint shuts down December 31, 2026. Use the v5 GET /ns/{namespace}/connectors/{id} endpoint for new integrations. Retrieve a legacy connection by ID, including available provider metadata and the latest sync run status.

Input Parameters

string
required
ID of the connection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_CONNECTORRead a connector in a namespace, including its setup, selection, and latest sync status. Optionally include the 10 most recent sync runs with failed items or a one-time hosted picker URL. Requesting picker requires admin write access because the link allows changing what syncs.

Input Parameters

string
required
Connector identifier returned when the connector was created.
array
Optional extras: syncs returns the 10 most recent sync runs with failed items; picker returns a one-time hosted picker URL and requires admin write access because it allows changing what syncs.
string
required
Namespace identifying the user, project, or other connector scope.
string
URI where the hosted picker sends the user when finished.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_CONTAINER_TAGDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use v5 GET /ns/{namespace} for namespace settings instead. Get a container tag’s display name, entity context, memory filesystem paths, profile buckets, and creation and update timestamps.

Input Parameters

string
required
Container tag identifier whose settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_CONTAINER_TAG_MERGEDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Get the status and progress of a queued container tag merge by its merge job ID, including copied rows, renamed custom IDs, and the last error. This read does not start or retry a merge.

Input Parameters

string
required
Merge job ID returned when queuing a container tag merge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_DOCUMENTGet one document’s content, metadata, source details, and processing status by document ID.

Input Parameters

string
required
Supermemory document ID returned by Add Document or List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_DOCUMENT_CHUNKSReturn the ordered extracted chunks for one processed document.

Input Parameters

string
required
Processed Supermemory document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_DOCUMENT_FILE_URLDeprecated by the provider: this legacy endpoint shuts down December 31, 2026. Get a fresh presigned download URL for a document’s uploaded file. The URL is valid for 24 hours. Returns an error if the document does not exist or has no file.

Input Parameters

string
required
ID of the Supermemory document whose uploaded file URL to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_ERROR_ANALYTICSDeprecated legacy v3 endpoint scheduled to shut down December 31, 2026. Retrieve organization-wide error analytics, including request-type summaries, HTTP error breakdowns, hourly trends, and per-key metrics for a time window. Returns one page; increment page using the returned pagination metadata.

Input Parameters

string
ISO 8601 end date/time for the analytics period.
integer
Page number, starting at 1.
integer
Items per page (1-100); defaults to 20.
string ("24h" | "7d" | "30d" | "all")
Relative time window, as an alternative to from_date; use date bounds for other windows.
string
ISO 8601 start date/time for the analytics period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_NAMESPACERead a namespace’s supporting context and lifecycle timestamps. Supporting context helps Supermemory understand content and form better memories inside this namespace.

Input Parameters

string
required
Namespace identifier used to scope documents and memories, such as a user or project ID. Maximum 100 characters; letters, numbers, underscores, colons, and hyphens only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_NAMESPACE_DOCUMENTRetrieve a document’s canonical content, metadata, and processing state by document ID or caller-defined ID within a namespace. Optionally include source chunks, derived memories, or both. Processing status done does not necessarily mean memory generation is complete; inspect dreamingStatus separately.

Input Parameters

string
required
Public document ID or caller-defined document ID.
array
Child resources to include: chunks, memories, or both. Omit for document only.
string
required
Isolated namespace identifying a user, project, or other document scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_NAMESPACE_MEMORYRetrieve one memory by ID within a namespace, including its text, metadata, version, and recall flags. Optionally include version history up to three steps away (nearest first), direct extends and derives links, and source documents. relatedLimit caps each related list separately.

Input Parameters

string
required
Memory identifier.
array
Extras to retrieve: related includes version history and connected memories; documents includes the source document and, with related, their documents.
string
required
Namespace identifying the user, project, or other memory scope.
Maximum entries per parents, children, and siblings list (1-100; default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_NAMESPACE_PROFILERead the continuously maintained profile of a namespace’s subject without a search query. Returns stable facts, evolving context, and custom buckets; optionally restrict contributing memories with metadata filters or select buckets.

Input Parameters

string
Type-safe metadata conditions limiting which memories contribute to the profile.
array
Up to 50 custom bucket slugs to return. Omit to return every effective bucket.
string
required
Isolated namespace identifying the subject, user, or project to profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_NAMESPACE_PROFILE_BUCKETSInspect the profile taxonomy active in a Supermemory namespace. Returns a name-to-description map combining organization-wide profile buckets with namespace-owned additions.

Input Parameters

string
required
Namespace whose effective profile bucket definitions to retrieve. Use a user, project, or other identifier of at most 100 characters, containing only letters, numbers, underscores, colons, and hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_ORGANIZATIONRead the connected organization’s shared background that guides memory formation across all namespaces, together with its active namespace count. This action takes no parameters and does not change organization settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_PROFILERetrieve the static, dynamic, or bucketed profile learned for one container tag, optionally with matching search results.

Input Parameters

string
Optional query that also returns matching profile search results.
array
Specific profile bucket keys to return when buckets are included.
object
Root metadata filter. Choose AND or OR, never both; operands may be conditions or one nested AND/OR group containing conditions. Deeper groups are unsupported.
array
Profile sections to return: static, dynamic, or buckets. Omit this field to return all available sections.
number
Minimum score from 0 to 1 for optional search results.
string
required
Container tag whose learned profile should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_PROFILE_BUCKETSDeprecated by the provider: this legacy v4 endpoint shuts down on December 31, 2026. Use v5 GET /ns/{namespace}/profile/buckets instead. Return the effective profile bucket definitions for a container tag, merging organization-level buckets with container-tag-level additions.

Input Parameters

string
required
Tag to resolve effective bucket definitions for. Can be a user ID, project ID, or any identifier used to scope memories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_PROVIDER_CONNECTIONDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use v5 LIST_CONNECTORS to find namespace connectors and GET_CONNECTOR to retrieve one by ID. Retrieve a legacy connection by provider and container tags, including its latest synchronization status when available. This POST only reads connection details.

Input Parameters

string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
required
Provider whose connection should be retrieved.
array
required
One or more container tags that identify the provider connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_SETTINGSDeprecated legacy v3 API, scheduled to shut down December 31, 2026. Use the v5 organization and namespace settings APIs for new integrations. Retrieve the connected organization’s ingestion filters, connector OAuth configuration, chunk size, and profile buckets. Connector client secrets are omitted from the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_GET_USAGE_ANALYTICSDeprecated legacy v3 API, scheduled to shut down December 31, 2026. Get organization-wide request usage analytics, including counts by request type, hourly performance, per-API-key metrics, and total memories. Filter by a relative period or ISO 8601 from_ and to bounds. Returns one page; use pagination to request further pages. Recorded tokensUsed is not the billable ingestion-token meter.

Input Parameters

string
ISO 8601 end date/time for the analytics window.
integer
Page number, starting at 1.
string
ISO 8601 start date/time; alternative to period.
integer
Items per page, from 1 to 100; defaults to 20.
string ("24h" | "7d" | "30d" | "all")
Relative time window, as an alternative to from_.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_INGEST_CONVERSATIONDeprecated by the provider: the v3/v4 API shuts down December 31, 2026. For new integrations, ingest a conversation transcript through v5 POST /ns/{namespace}/document instead. Ingest or update a conversation by its conversationId using structured messages, optional container tags, and metadata. Returns the backing document ID and processing status, not a guarantee that asynchronous processing has finished.

Input Parameters

array
required
One or more structured conversation messages to ingest.
object
Flat conversation metadata with string, numeric, or boolean values.
array
Container tags grouping the conversation; each is at most 100 letters, digits, underscores, colons, or hyphens.
string
required
Caller-supplied conversation identifier used to ingest or update a conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_ALL_CONNECTORSList one page of connectors across every namespace the API key can read, optionally filtered by provider. Use for admin views spanning users or projects. Pending connectors are not listed. Increment page up to pagination.totalPages to retrieve subsequent pages.

Input Parameters

integer
One-based page number.
integer
Maximum connectors to return per page (1-100).
string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
Only return connectors for this provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_CONNECTION_DOCUMENTSDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. For v5 document listing, use LIST_NAMESPACE_RESOURCES with type documents; v5 connectors are namespace-scoped. List documents indexed for a connected provider, optionally filtered by container tags. Returns document IDs, processing statuses, titles, summaries, types, and timestamps.

Input Parameters

string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
required
Connected provider whose indexed documents to list.
array
Optional array of container tags to filter documents by. Each tag is at most 100 characters and contains only letters, numbers, underscores, colons, or hyphens. Omit to list without a container-tag filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_CONNECTION_RESOURCESDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. List one page of accessible resources for a connection; only GitHub is currently documented as supported. Use page and per_page to request additional pages, and parent_id to scope resources to a parent.

Input Parameters

string
Page of accessible resources to fetch; defaults to 1.
string
Number of resources per page; defaults to 30.
string
Optional parent resource ID to fetch resources beneath.
string
required
ID of the connection whose accessible resources to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_CONNECTIONSDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Use v5 LIST_CONNECTORS for namespace connectors or LIST_ALL_CONNECTORS across namespaces. List all legacy connections, optionally filtered by container tags, including the latest synchronization status when available.

Input Parameters

array
Optional container tags to filter connections by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_CONNECTORSList one page of connectors that sync into a namespace, optionally filtered by provider. Pending authorization connectors are not listed. Use page and limit with the returned pagination metadata to retrieve subsequent pages.

Input Parameters

integer
One-based page number to retrieve.
integer
Maximum connectors per page, from 1 to 100.
string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
Only return connectors for this external provider.
string
required
Namespace identifier that scopes the connectors, up to 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_CONTAINER_TAGSDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Use the v5 namespace listing API for new integrations. List all container tags, optionally restricted by a comma-separated filter, including summaries, Nova flags, document and memory counts, and active merge details.

Input Parameters

string
Comma-separated container tags to limit the list to; omit to list all tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_DOCUMENTSList documents, optionally filtered by containers, metadata, or filepath, one page at a time.

Input Parameters

string ("createdAt" | "updatedAt")
Timestamp field used for sorting.
integer
Maximum documents to return in this page (1-1100).
string ("asc" | "desc")
Sort direction.
object
Root metadata filter. Choose AND or OR, never both; operands may be conditions or one nested AND/OR group containing conditions. Deeper groups are unsupported.
string
Exact filepath, or a directory prefix ending in /, used to filter documents.
string
Opaque cursor returned by the previous call; omit for the first page.
array
Only return documents in any of these container tags.
boolean
Include full document content. Leave false unless content is needed because responses can become large.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_INFERRED_MEMORIESList a namespace’s inferred memories awaiting review. This review route is still served under v3; pass the namespace as containerTag. Returns up to 50 memories ordered by parentCount descending, then createdAt descending, excluding forgotten, expired, or reviewed memories. No pagination is documented; total can exceed the returned count. Unknown or empty namespaces return an empty list and zero total. No v5 replacement is documented.

Input Parameters

string
required
Namespace whose inferred-memory review queue to read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_INVOICESDeprecated legacy v3 API, scheduled to shut down December 31, 2026. List the connected Supermemory organization’s billing invoices without changing billing settings or purchasing credits. Requires an unscoped organization API key; scoped API keys cannot read billing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_MEMORIESList extracted memory entries for one or more container tags, one page at a time.

Input Parameters

string ("createdAt" | "updatedAt")
Timestamp field used for sorting.
integer
Maximum memories to return in this page (1-1100).
string ("asc" | "desc")
Sort direction.
object
Root metadata filter. Choose AND or OR, never both; operands may be conditions or one nested AND/OR group containing conditions. Deeper groups are unsupported.
string
Opaque cursor returned by the previous call; omit for the first page.
array
required
One or more container tags whose memory entries should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_NAMESPACE_RESOURCESBrowse one page of documents, extracted chunks, or learned memories in a namespace. The other collection arrays are empty. Use pagination.totalPages and page to retrieve further pages. Position sorting is for chunks only; include.content and include.memoryCount apply to documents, and include.forgotten applies to memories.

Input Parameters

integer
One-based page number.
string ("createdAt" | "updatedAt" | "position")
Sort field; position is available only for chunks.
string ("documents" | "chunks" | "memories")
required
Resource collection to list.
integer
Maximum resources per page, from 1 to 100.
string ("asc" | "desc")
Ascending or descending sort direction.
string
Metadata conditions before pagination; at most five levels.
object
Optional document content/counts or forgotten memories.
string
required
User or project namespace, up to 100 letters, digits, underscores, colons, or hyphens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_NAMESPACESList namespaces available to the caller, newest first, including their purpose, document and memory counts, and lifecycle timestamps. Optionally filter names with q. Returns one page; use page and the returned pagination to fetch more.

Input Parameters

string
Case-insensitive substring to match against namespace names (up to 100 characters).
integer
One-based page number.
integer
Maximum namespaces to return per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_PROCESSING_DOCUMENTSDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Use the v5 namespace document listing API for new integrations. List the live processing queue, all unfinished documents, or unfinished and failed documents. For view=all, fetch subsequent pages using page and limit and inspect the returned pagination information.

Input Parameters

string
Page number for view=all, as a number or digit-only string.
string ("active" | "pending" | "all")
active returns in-flight documents updated in the last four hours; pending returns all unfinished, non-failed documents without a time cutoff; all also includes failed documents and supports pagination.
string
Items per page for view=all, as a number or digit-only string.
string
Comma-separated container tags to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_LIST_REQUEST_LOGSDeprecated legacy v3 endpoint scheduled to shut down December 31, 2026. List one page of organization-wide request logs filtered by time. Use pagination metadata and increment page to continue. Outputs are compacted and may be truncated. The ordinary tracker skips HTTP 402, 404, and 500 responses, so logs are not a complete audit trail. Historical retention is not guaranteed. Request type, status code, and API key filters are not supported.

Input Parameters

string
ISO 8601 end date/time for the log window.
integer
Page number, starting at 1.
integer
Logs per page (1-100); defaults to 20.
string ("24h" | "7d" | "30d" | "all")
Relative time window instead of from_date; use date bounds for other windows.
string
ISO 8601 start date/time for the log window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_MERGE_CONTAINER_TAGSDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Queue a merge of exactly two container tags into a target tag. All source documents are updated to reference the target, and source tags are deleted after a successful merge. Requires an organization admin or owner. The response confirms queuing, not completion; use GET_CONTAINER_TAG_MERGE with the returned mergeId to check progress.

Input Parameters

array
required
Exactly two container tags whose documents will be merged into the target.
string
required
Target container tag. Must be one of containerTags or a new tag that does not already exist in the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_REPLACE_NAMESPACE_FILEReplace an existing document with a new file within an isolated namespace, keeping its stable document ID. Content and caller metadata are overwritten and the document is reprocessed asynchronously. The returned status reports processing state, not guaranteed completion. Requires namespace write access.

Input Parameters

string
required
Public ID of the existing document to replace.
string
When the source content is from, in ISO 8601 format.
object
required
New file contents to replace the document.
string
JSON-encoded metadata keeping related context isolated during processing and recall.
string ("dynamic" | "instant")
Processing mode: dynamic (provider default) groups related documents; instant processes independently right away and bills one extra operation per document.
string
JSON-encoded metadata to attach to the document and its derived memories; replaces caller metadata.
string ("text" | "pdf" | "image" | "video" | "audio")
Explicit source type when automatic inference is insufficient.
string
Explicit MIME type when upload metadata is insufficient.
string
required
Isolated namespace containing the document, such as a user or project ID.
string ("memory" | "superrag")
Processing pipeline: memory builds durable learned context; superrag optimizes retrieval without generating memories.
string
Context guiding memory extraction within this namespace, up to 1500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_RESET_ORGANIZATION_DATADeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Destructively reset the ENTIRE connected organization’s content: delete documents, memories, spaces except the default project, connections, and organization settings, and clear the default space context. Preserves the organization itself, members, and billing. This is not scoped to an individual document, container tag, or namespace. Only call with explicit authorization to delete the entire organization’s data.

Input Parameters

string
required
Required nonempty confirmation string for the destructive entire-organization reset. The provider does not document the required confirmation value; obtain it from Supermemory before calling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_REVIEW_INFERRED_MEMORYProvider deprecation notice: legacy v3/v4 APIs are scheduled to shut down December 31, 2026. These review routes still serve namespaces under v3; no v5 replacement is documented. Approve, decline, or undo a review of one inferred memory in a namespace. Approve confirms the fact; decline forgets it and removes it from search; undo restores the unreviewed inferred state, including un-forgetting a declined memory. Requires a key with write access to the namespace. A non-reviewable memory or an undo without a prior review returns 409.

Input Parameters

string ("approve" | "decline" | "undo")
required
approve confirms the inferred fact; decline forgets it and removes it from search; undo clears a prior review and un-forgets the memory, returning it to the review queue. There is no reject or skip action.
string
required
Memory entry ID returned by the inferred-memory review queue.
string
required
Namespace the inferred memory belongs to; passed as the legacy containerTag path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_REVOKE_SCOPED_KEYDeprecated by the provider: this legacy v3 endpoint shuts down on December 31, 2026. Revoke a scoped API key using the ID returned at creation. Subsequent requests using the revoked key receive 401. Memories and namespaces are not deleted. Authenticate with an organization API key, not a scoped key.

Input Parameters

string
required
ID returned when the scoped API key was created, not the secret key value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SEARCH_CONTEXTSemantically search Supermemory memories, document chunks, or both, with optional container and metadata filters.

Input Parameters

integer
Maximum results to return (1-100); this endpoint has no continuation token.
string
required
Natural-language search query.
boolean
Rerank matches for improved relevance.
object
Root metadata filter. Choose AND or OR, never both; operands may be conditions or one nested AND/OR group containing conditions. Deeper groups are unsupported.
object
Optional associated content to include: documents, summaries, related memories, and forgotten memories.
boolean
Synthesize information across matches; intended to be used with reranking.
number
Minimum relevance threshold from 0 to 1; higher values return fewer, stricter matches.
string ("memories" | "hybrid" | "documents")
Search memories, document chunks, or both.
boolean
Rewrite the query for retrieval at additional latency.
array
Restrict search to memories under these container tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SEARCH_DOCUMENTSDeprecated by the provider: legacy v3/v4 APIs shut down December 31, 2026. Use v5 namespace search (POST /ns/{namespace}/search) for new integrations. Search documents and their content chunks with optional container, document, metadata, and filepath filters. Returns one bounded result set with relevance scores and optional full content or summaries.

Input Parameters

string
required
Nonempty search query string.
string
Document ID to restrict chunk search to one document.
integer
Maximum document results (1-100); defaults to 10.
boolean
Rerank results for the query; defaults to false.
string
Root AND/OR filter object, or its JSON string representation.
string
Filter by exact filepath, or by prefix when ending with /.
string
Single container tag to search; use this or containerTags.
boolean
Rewrite the query for retrieval; defaults to false and adds about 400ms latency when enabled.
array
Container tags used to scope the document search.
number
Chunk selection sensitivity, from 0 (most chunks, default) to 1 (most selective).
boolean
Include document summaries; defaults to false.
boolean
Include full document content; defaults to false.
array
Deprecated optional category filters.
number
Deprecated and ignored by v3 search; use chunkThreshold instead. Provider default is 0.
boolean
Return only matching chunks (default true); false also includes surrounding context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SEARCH_NAMESPACERecall relevant learned context and source passages from an isolated namespace. Hybrid search combines memories and document chunks by default. Supports typed metadata filters (up to five levels), query rewriting, reranking, and optional source documents and related memories.

Input Parameters

integer
Maximum results, from 1 to 100.
string
required
Natural-language question, topic, or phrase to retrieve context for.
string
Type-safe metadata filter; at most five expression levels.
string ("none" | "order" | "aggregate")
No reranking, improved ordering, or ordering plus overlapping-context aggregation.
object
Supporting context and forgotten-memory options; all default false.
string
required
Isolated user or project namespace; up to 100 letters, digits, underscores, colons, or hyphens.
number
Minimum relevance from 0 to 1; higher favors precision.
string ("hybrid" | "memories" | "chunks")
Search learned memories, source chunks, or both (hybrid).
boolean
Expand and clarify the query; adds about 400ms latency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SEND_FEEDBACKSend a bug report, feature request, documentation problem, or other feedback to the Supermemory team. This contacts real engineers and consumes the organization’s quota of three submissions per UTC day, subject to a shared authenticated pool of 200 per day. Do not automatically retry uncertain deliveries, including HTTP 502: delivery may already have occurred.

Input Parameters

string ("bug" | "feature_request" | "docs" | "other")
required
Kind of feedback to send to the Supermemory team.
string
required
One-line summary of the feedback.
string
What actually happened.
string
Agent, tool, or SDK sending the feedback.
string
API operation the feedback is about.
string
What you expected to happen.
string
Request ID of a failing call, if available.
string
required
What happened, with enough detail for an engineer to act on it.
string
Email address where the Supermemory team can reach you about this feedback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SUGGEST_PROFILE_BUCKETSDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Suggest profile bucket definitions using the organization’s saved context prompt. Returns 3 to 6 suggestions tailored to that context without saving bucket definitions. Fails when no organization context is available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SYNC_CONNECTIONDeprecated provider v3 API; shuts down December 31, 2026. For v5, use SYNC_CONNECTOR with a namespace and connector ID instead. Initiate a manual sync of connections for a provider, optionally filtered by container tags. The acknowledgement means importing was accepted, not that sync has finished.

Input Parameters

string ("notion" | "google-drive" | "onedrive" | "gmail" | "github" | "web-crawler" | "s3" | "granola")
required
Provider whose connections should be manually synced.
array
Optional array of container tags to filter connections by. Each tag allows letters, numbers, underscores, colons, and hyphens, up to 100 characters. Omit to sync without a container-tag filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_SYNC_CONNECTORStart a sync now for a connector in a namespace. Returns the connector ID and queued status, not a completed sync result. Returns a conflict if a sync for this connector is already running. Use Get Connector to inspect sync progress and results.

Input Parameters

string
required
Connector identifier returned when the connector was created.
string
required
Namespace identifying the user, project, or other connector scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_CONNECTORChange what a connector syncs in a namespace or its maximum document count. A supplied selection replaces the old selection and starts a sync. Only send selection for providers that support choosing resources. Returns the updated connector and its latest sync status.

Input Parameters

string
required
Connector identifier returned when the connector was created.
string
required
Namespace identifying the user, project, or other connector scope.
object
Resource IDs grouped by kind. Replaces the entire current selection and starts a sync. GitHub uses repos, Gmail labels, Google Drive files and folders, and OneDrive folders. Omit to retain the current selection.
integer
Maximum documents this connector imports, from 1 to 10000; omit to retain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_CONTAINER_TAGDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Use the v5 namespace settings API (PATCH /ns/{namespace}) for new integrations. Update an existing container tag’s display name, document processing context, memory filesystem paths, or tag-level profile buckets. Omitted fields remain unchanged; explicit nulls are sent for fields that support them.

Input Parameters

string
Display name, from 1 to 100 characters; does not change the tag identifier.
string
required
Identifier of the existing container tag whose settings should change.
string
Context prompt for processing documents, up to 1500 characters; null clears it.
array
Up to 50 tag-level profile buckets. Replaces this tag’s own list, adding on top of organization buckets without overriding or removing them.
array
Filesystem path allowlist for memory generation on mount-ingested documents. Nonmatching documents use superrag without memory extraction; accepts null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_DOCUMENTUpdate the content, metadata, container, or processing configuration of one existing document. When metadata is supplied, it completely replaces the document’s metadata, so omitted metadata keys are removed.

Input Parameters

string
Replacement text or public URL to process.
object
Complete replacement metadata object; omitted keys are removed.
string
Replacement caller-defined document ID.
string ("memory" | "superrag")
Replacement processing task type.
string
required
Supermemory document ID returned by Add Document or List Documents.
string
Replacement container tag, up to 100 characters. Use only letters, numbers, underscores, colons, and hyphens.
object
Replacement flat metadata filter for contextual memories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_MEMORYDeprecated by the provider; v3/v4 APIs shut down on December 31, 2026. Use v5 namespace document updates for document-backed memory changes in new integrations. Update a memory by ID or exact content within a container, creating a new version. The original memory is preserved with isLatest=false. Omitted metadata and expiry inherit from the previous version; explicit null forgetAfter clears the expiry.

Input Parameters

string
ID of the memory to update. Supply this or an exact content match.
string
Exact content of the memory to update when its ID is unavailable.
object
Flat metadata with string, number, boolean, or string-array values. Omit to inherit the previous version’s metadata.
string
required
Nonempty replacement text for the new memory version.
string
ISO 8601 expiry datetime. Omit to inherit the previous expiry; pass null to clear it and its reason.
string
required
Container tag scoping the operation; up to 100 letters, digits, underscores, colons, or hyphens.
string
Reason for scheduled forgetting, or null. Cleared automatically when forgetAfter is null.
object
Structured temporal context merged into metadata. Omit to preserve existing temporal context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_NAMESPACEUpdate the background context used during ingestion and memory formation in an existing namespace. Omit supportingContext to leave it unchanged, or explicitly set it to null to clear it. Requires write access.

Input Parameters

string
required
Namespace identifier used to scope documents and memories, up to 100 characters.
string
Background guiding document interpretation and memory formation, up to 1500 characters. Set null to clear it; omit to leave it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_NAMESPACE_DOCUMENTPartially update an existing document in an isolated namespace without changing its stable ID. Supplied content replaces canonical content and is reprocessed; omitted fields remain unchanged. Returns the document ID and processing state, not a guarantee of completed processing.

Input Parameters

string
required
Public document ID to update without changing its stable identity.
string
Source content date in ISO 8601 format; omit to leave unchanged.
object
Metadata values isolating related context within the namespace. Values may be strings, numbers, booleans, or string arrays.
string
Replacement plaintext or URL to supported rich content. Supplied content is reprocessed; omitted content remains unchanged.
string ("dynamic" | "instant")
Processing mode: dynamic (provider default) groups related documents; instant processes each independently and bills one extra operation per document.
object
Metadata attached to the document and derived data. Values may be strings, numbers, booleans, or string arrays; omit to leave unchanged.
string
required
Isolated namespace containing the document, such as a user or project ID.
string ("memory" | "superrag")
Processing pipeline: memory builds durable learned context; superrag optimizes retrieval without generating memories. Omit to leave unchanged.
string
Context guiding memory extraction within this namespace, up to 1500 characters. Omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_NAMESPACE_FILEPartially update a file-backed document in an isolated namespace. Supply a file to replace canonical content, or update metadata and processing context without a file. Omitted metadata and processing context remain unchanged. Returns the document ID and current processing state, not a guarantee of completed processing.

Input Parameters

string
required
Public document ID to update.
string
Source content date in ISO 8601 format.
object
Optional replacement file. Supplying it replaces the canonical content.
string
JSON-encoded metadata keeping related context isolated during processing and recall.
string ("dynamic" | "instant")
Processing mode: dynamic groups related documents; instant processes independently and bills one extra operation. Omit to retain provider behavior.
string
JSON-encoded metadata to attach to the document and derived memories; omitted metadata remains unchanged.
string ("text" | "pdf" | "image" | "video" | "audio")
Explicit source type when automatic inference is insufficient.
string
Explicit MIME type when upload metadata is insufficient, such as application/pdf.
string
required
Isolated namespace containing the document, such as a user or project ID.
string ("memory" | "superrag")
Processing pipeline: memory builds learned context; superrag optimizes retrieval without generating memories.
string
Context guiding memory extraction within this namespace; omitted context remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_ORGANIZATIONUpdate organization-wide background that guides content interpretation and memory formation across every namespace. Provide organizationalContext as a nonempty string to set it, or null to remove the existing context. Requires admin access.

Input Parameters

string
required
Shared background guiding memory formation across every namespace. Provide a nonempty string to set it, or null to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPDATE_SETTINGSDeprecated by the provider: the legacy v3 API shuts down December 31, 2026. Use v5 organization and namespace settings APIs for new integrations. Update the connected organization’s settings, including filtering, custom connector OAuth credentials, chunk size, and profile buckets. Omitted fields are unchanged; explicit nulls are sent to the provider. This changes live organization configuration. Connector client secrets are accepted as input but omitted from the response.

Input Parameters

integer
Organization chunk size, a signed 32-bit integer, or null to clear it.
string
Provider-defined JSON exclusion configuration; null clears it.
string
Organization filtering prompt; null clears it. Enable shouldLLMFilter to set a nonempty prompt.
string
Provider-defined JSON inclusion configuration; null clears it.
string
Custom GitHub OAuth client ID; null clears it.
string
Custom Notion OAuth client ID; null clears it.
array
Up to 50 profile bucket definitions; an empty list removes all buckets.
boolean
Whether LLM-based filtering is enabled. Required for nonempty filterPrompt, includeItems, or excludeItems settings.
string
Custom OneDrive OAuth client ID; null clears it.
string
Custom GitHub OAuth client secret; null clears it.
string
Custom Notion OAuth client secret; null clears it.
string
Custom Google Drive OAuth client ID; null clears it.
string
Custom OneDrive OAuth client secret; null clears it.
boolean
Whether custom GitHub OAuth credentials are enabled.
boolean
Whether custom Notion OAuth credentials are enabled.
string
Custom Google Drive OAuth client secret; null clears it.
boolean
Whether custom OneDrive OAuth credentials are enabled.
boolean
Whether custom Google Drive OAuth credentials are enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPLOAD_DOCUMENT_FILEDeprecated by the provider: this legacy endpoint shuts down December 31, 2026. Use the v5 namespace file upload endpoint POST /ns/{namespace}/document/file for new integrations. Upload a file as a document for processing, with optional container tags, metadata, and extraction settings. The returned status reports processing state and does not guarantee processing has finished.

Input Parameters

object
required
File to upload and process.
string ("instant" | "dynamic")
Processing mode: dynamic (provider default) groups related documents; instant processes this document independently and bills one extra operation.
string
Optional filesystem mapping path, such as /documents/reports/file.pdf.
string
Document metadata as a JSON object string; values may be strings, numbers, or booleans.
string
Caller-defined document ID, at most 100 characters using letters, numbers, hyphens, underscores, and colons only.
string ("text" | "pdf" | "tweet" | "google_doc" | "google_slide" | "google_sheet" | "image" | "video" | "notion_doc" | "webpage" | "onedrive")
Optional override forcing a specific file processing type.
string
Exact MIME type, required when file_type is image or video (for example image/png or video/mp4).
string ("memory" | "superrag")
Processing task: memory (provider default) for the full context layer, or superrag for managed retrieval.
string
Single container tag used to group the uploaded document.
string
Deprecated: use container_tag. A single tag or a JSON array string of tags.
string
Context about the container entity to guide memory extraction, at most 1500 characters.
string
Metadata filter as a JSON object string, scoping existing memories used as ingestion context. Keys combine with AND; array values match ANY value.
string
Deprecated and ignored by the provider; advanced PDF processing is now automatic. Accepted as a string for backward compatibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPLOAD_NAMESPACE_FILEUpload a file into an isolated Supermemory namespace to form searchable knowledge and learned memory. Ingestion returns once safely queued; extraction and memory formation continue asynchronously. The returned status is the document’s current processing state, not a guarantee that processing has completed. Use task_type=superrag for retrieval without generating memories.

Input Parameters

string
When the source content is from, in ISO 8601 format.
object
required
File contents to upload and process.
string
JSON-encoded metadata keeping related context isolated during processing and recall.
string ("dynamic" | "instant")
Processing mode: dynamic (provider default) groups related documents; instant processes each document independently right away and bills one extra operation per document.
string
JSON-encoded metadata to attach to the document and its derived memories.
string ("text" | "pdf" | "image" | "video" | "audio")
Explicit source type used when automatic inference is insufficient.
string
Explicit MIME type used when upload metadata is insufficient, such as application/pdf.
string
required
Isolated namespace identifying the user or project whose documents to ingest.
string ("memory" | "superrag")
Processing pipeline: memory builds durable learned context; superrag optimizes retrieval without generating memories.
string
Context guiding memory extraction within this namespace, up to 1500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERMEMORY_UPSERT_NAMESPACE_PROFILE_BUCKETSAdd or update namespace-owned profile bucket definitions that guide memory classification. Omitted buckets remain unchanged. Organization-wide buckets are protected and cannot be changed. Returns the effective definitions, including organization buckets. Requires namespace write access.

Input Parameters

object
required
Namespace-owned bucket names mapped to descriptions guiding memory classification. Names are 1-64 lowercase letters, digits, underscores, or hyphens, starting with a letter or digit. Descriptions have at most 2000 characters. Existing names are updated; new names are added.
string
required
Namespace identifier that scopes the profile bucket definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not