NAiOS IconNAiOS Logo
Volver al catálogo

Mem0

mem0

Mem0 is an universal, self-improving memory layer for LLM applications.

Acciones
43
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (43)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add member to projectMEM0_ADD_MEMBER_TO_PROJECTAcción

Adds an existing user to a project (identified by `project id` within organization `org id`), assigning a valid system role.

Parámetros de entrada

  • rolestringObligatorio

    Role defining the new member's project permissions (e.g., 'Admin', 'Editor').

  • org_idstringObligatorio

    Identifier of the organization owning the project.

  • usernamestringObligatorio

    Username of the user to add to the project.

  • project_idstringObligatorio

    Identifier of the project to add the member to.

Parámetros de salida

  • dataobjectObligatorio

    Server's response, typically including details of the added member or a success confirmation.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add new memory recordsMEM0_ADD_NEW_MEMORY_RECORDSAcción

Stores new memory records from a list of messages, optionally inferring structured content; requires association via `agent id`, `user id`, `app id`, or `run id`.

Parámetros de entrada

  • inferboolean

    If true, infers structured memories from messages; otherwise, stores messages directly.

  • app_idstring

    Unique identifier for the application associated with this memory.

  • org_idstring

    Optional unique identifier for the organization associated with this memory.

  • run_idstring

    Unique identifier for the run associated with this memory.

  • user_idstring

    Unique identifier for the user associated with this memory.

  • agent_idstring

    Unique identifier for the agent associated with this memory.

  • excludesstring

    Comma-separated keywords to exclude specific topics, aiding in filtering out irrelevant information.

  • includesstring

    Comma-separated keywords to include specific topics, aiding filtering and prioritization.

  • messagesobject[]Obligatorio

    List of message objects forming the memory's content, representing conversations or multi-part memories.

  • org_namestring

    The name of the organization for this memory. Deprecated: use `org_id` instead.

  • project_idstring

    Optional unique identifier for the project associated with this memory.

  • project_namestring

    The name of the project for this memory. Deprecated: use `project_id` instead.

  • output_formatstring

    Specifies the response output format. 'v1.1' offers enhanced detail; 'v1.0' (default) will be deprecated.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add organization memberMEM0_ADD_ORGANIZATION_MEMBERAcción

Adds a new member, who must be a registered user, to an organization, assigning them a specific role.

Parámetros de entrada

  • rolestringObligatorio

    The role (should be in uppercase) to be assigned to the user within the organization (allowed values: 'OWNER' and 'READER'). This dictates the user's permissions.

  • emailstringObligatorio

    The email of the user to be added to the organization.

  • org_idstringObligatorio

    Unique identifier of the organization to which the member will be added.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new agentMEM0_CREATE_A_NEW_AGENTAcción

Creates a new agent with a unique `agent id` and an optional `name`; additional metadata may be assigned by the system.

Parámetros de entrada

  • namestring

    Human-readable name for the agent, used for display or easier identification.

  • agent_idstringObligatorio

    Unique identifier for the agent, used for referencing in subsequent API calls.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new agent runMEM0_CREATE_A_NEW_AGENT_RUNAcción

Creates a new agent run in the mem0.ai system.

Parámetros de entrada

  • namestring

    Human-readable name for the agent run.

  • run_idstringObligatorio

    Client-defined identifier for the agent run. Should be unique for distinct identification.

Parámetros de salida

  • dataobjectObligatorio

    Details and data of the newly created agent run; specific contents can vary.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new applicationMEM0_CREATE_A_NEW_APPLICATIONAcción

Creates a new application, allowing metadata to be passed in the request body (not an explicit field in this action's request model); ensure `app id` is unique to avoid potential errors or unintended updates.

Parámetros de entrada

  • namestring

    An optional, human-readable name for the application. If not provided, the application might be created without a specific name or with a default one.

  • app_idstringObligatorio

    The unique identifier for the application to be created. This ID will be used to reference the application in subsequent API calls.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the attributes of the newly created application. This typically includes the `app_id`, `name` (if provided), and any other relevant information or metadata returned by the API upon successful creation.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new organization entryMEM0_CREATE_A_NEW_ORGANIZATION_ENTRYAcción

Creates a new organization entry using the provided name and returns its details.

Parámetros de entrada

  • namestringObligatorio

    The name for the new organization.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new userMEM0_CREATE_A_NEW_USERAcción

Creates a new user with the specified unique `user id` and supports associating `metadata` (not part of the request schema fields).

Parámetros de entrada

  • user_idstringObligatorio

    The unique identifier for the new user. This ID will be used for future references to this user.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the details of the successfully created user, which may include the `user_id` and other attributes returned by the API.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create an export job with schemaMEM0_CREATE_AN_EXPORT_JOB_WITH_SCHEMAAcción

Initiates an asynchronous job to export memories, structured by a schema provided in the request body and allowing optional filters.

Parámetros de entrada

  • app_idstring

    Filters memories for export; if provided, only memories from this application are included.

  • org_idstring

    Filters memories for export; if provided, only memories from this organization are included.

  • run_idstring

    Filters memories for export; if provided, only memories from this run are included.

  • user_idstring

    Filters memories for export; if provided, only memories of this user are included.

  • project_idstring

    Filters memories for export; if provided, only memories from this project are included.

  • session_idstring

    Filters memories for export; if provided, only memories from this session are included.

Parámetros de salida

  • dataobjectObligatorio

    Information about the created export job, such as its `job_id` and status, used for tracking and retrieving results.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create memory entryMEM0_CREATE_MEMORY_ENTRYAcción

Lists/searches existing memory entries with filtering and pagination; critically, this action retrieves memories and does *not* create new ones, despite its name.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (1-indexed).

  • org_idstring

    Unique organization ID to filter memories. Preferred over the deprecated `org_name`.

  • filtersobject

    Key-value pairs to filter memories (e.g., 'user_id', 'custom_data.key'), enabling complex, multi-field searches.

  • org_namestring

    DEPRECATED: Organization name to filter memories. Use `org_id` instead for improved stability and future compatibility.

  • page_sizeinteger

    Number of memory entries per page.

  • project_idstring

    Unique project ID to filter memories. Preferred over the deprecated `project_name`.

  • project_namestring

    DEPRECATED: Project name to filter memories. Use `project_id` instead for improved stability and future compatibility.

Parámetros de salida

  • dataobjectObligatorio

    Data from the memory listing, typically including a list of matching memory entries and pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create projectMEM0_CREATE_PROJECTAcción

Creates a new project with a given name within an organization that must already exist.

Parámetros de entrada

  • namestringObligatorio

    The name to be assigned to the new project.

  • org_idstringObligatorio

    The unique identifier of the organization under which the new project will be created.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the attributes and information of the successfully created project. The specific keys and values will depend on the project details stored by the system, typically including 'id', 'name', 'org_id', and creation timestamps.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete an organizationMEM0_DELETE_AN_ORGANIZATIONAcción

Permanently deletes an existing organization identified by its unique id.

Parámetros de entrada

  • org_idstringObligatorio

    The unique identifier of the organization that is to be deleted.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the API's response data. For a successful deletion, this might be an empty dictionary or include a confirmation message.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete memory by idMEM0_DELETE_A_SPECIFIC_MEMORY_BY_IDAcción

Permanently deletes a specific memory by its unique id; ensure the `memory id` exists as this operation is irreversible.

Parámetros de entrada

  • memory_idstringObligatorio

    The unique identifier of the memory to be deleted.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete entity by type and idMEM0_DELETE_ENTITY_BY_TYPE_AND_IDAcción

Call to permanently and irreversibly hard-delete an existing entity (user, agent, app, or run) and all its associated data, using its type and id.

Parámetros de entrada

  • entity_idstringObligatorio

    Unique identifier (ID) of the entity for deletion.

  • entity_typestringObligatorioenum

    Type of the entity to be deleted.

    useragentapprun

Parámetros de salida

  • dataobjectObligatorio

    May contain a success message or status about the deletion.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete memoriesMEM0_DELETE_MEMORIES_ENDPOINTAcción

Deletes memories matching specified filter criteria; omitting all filters may result in deleting all memories. required: at least one of agent id, user id, app id, or run id must be provided.

Parámetros de entrada

  • app_idstring

    Deletes memories associated with this app ID.

  • org_idstring

    Deletes memories for this organization ID.

  • run_idstring

    Deletes memories associated with this run ID.

  • user_idstring

    Deletes memories associated with this user ID.

  • agent_idstring

    Deletes memories associated with this agent ID.

  • metadataobject

    Deletes memories matching this metadata (JSON string).

  • org_namestring

    Deletes memories for this organization name. Deprecated: use `org_id`.

  • project_idstring

    Deletes memories for this project ID.

  • project_namestring

    Deletes memories for this project name. Deprecated: use `project_id`.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete memory batch with uuidsMEM0_DELETE_MEMORY_BATCH_WITH_UUIDSAcción

Deletes a batch of up to 1000 existing memories, identified by their uuids, in a single api call.

Parámetros de entrada

  • memory_idsstring[]Obligatorio

    A list of unique memory identifiers (UUIDs) corresponding to the memories to be deleted.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the outcome of the batch delete operation. This may include a summary of successes, failures, or simply a confirmation message.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete projectMEM0_DELETE_PROJECTAcción

Permanently deletes a specific project and all its associated data from an organization; this action cannot be undone and requires the project to exist within the specified organization.

Parámetros de entrada

  • org_idstringObligatorio

    The unique identifier of the organization to which the project belongs.

  • project_idstringObligatorio

    The unique identifier of the project to be deleted.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the result of the delete operation, typically confirming success.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete project memberMEM0_DELETE_PROJECT_MEMBERAcción

Removes an existing member, specified by username, from a project, immediately revoking their project-specific access; the user is not removed from the organization.

Parámetros de entrada

  • org_idstringObligatorio

    Unique identifier of the organization containing the project.

  • usernamestringObligatorio

    Username of the member to be removed from the project.

  • project_idstringObligatorio

    Unique identifier of the project from which the member will be removed.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Export data based on filtersMEM0_EXPORT_DATA_BASED_ON_FILTERSAcción

Retrieves memory export data, optionally filtered by various identifiers (e.g., user id); without filters, it may return all accessible or recent exports based on default behavior.

Parámetros de entrada

  • app_idstring

    Filters exports by the specified App ID.

  • org_idstring

    Filters exports by the specified Organization ID.

  • run_idstring

    Filters exports by the specified Run ID.

  • user_idstring

    Filters exports by the specified User ID.

  • project_idstring

    Filters exports by the specified Project ID.

  • session_idstring

    Filters exports by the specified Session ID.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the resulting export data. The exact structure and content of this dictionary will depend on the specific export and the filters applied. It may represent a single export's data or a collection/summary if multiple exports are matched.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List organizationsMEM0_FETCH_DETAILED_LIST_OF_ORGANIZATIONSAcción

Retrieves a summary list of organizations for administrative oversight; returns summary data (names, ids), not exhaustive details, despite 'detailed' in the name.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch details of a specific organizationMEM0_FETCH_DETAILS_OF_A_SPECIFIC_ORGANIZATIONAcción

Fetches comprehensive details for an organization using its `org id`; the `org id` must be valid and for an existing organization.

Parámetros de entrada

  • org_idstringObligatorio

    Unique identifier of the organization.

Parámetros de salida

  • dataobjectObligatorio

    Organization attributes and details; structure varies by organization data model.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of entity filtersMEM0_FETCH_LIST_OF_ENTITY_FILTERSAcción

Retrieves predefined filter definitions for entities (e.g., by type, creation/modification date); returns definitions only, not filtered entity data.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing predefined filter definitions for entities. Keys typically represent filter names or categories, and values describe the filter's specifics, such as applicable fields (e.g., entity type, creation date, modification date) and how they can be used.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get entity by idMEM0_FETCH_SPECIFIC_ENTITY_DETAILS_WITH_OPTIONAL_FILTERSAcción

Fetches detailed information for an existing entity (user, agent, app, or run) identified by its type and unique id.

Parámetros de entrada

  • entity_idstringObligatorio

    The unique identifier (ID) of the entity to retrieve.

  • entity_typestringObligatorioenum

    The type of the entity (user, agent, app, or run).

    useragentapprun

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the detailed attributes and information of the fetched entity. The structure of this dictionary varies depending on the `entity_type`.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get organization membersMEM0_GET_ORGANIZATION_MEMBERSAcción

Fetches a list of members for a specified, existing organization.

Parámetros de entrada

  • org_idstringObligatorio

    The unique identifier of the organization for which members are to be listed.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get project detailsMEM0_GET_PROJECT_DETAILSAcción

Fetches comprehensive details for a specified project within an organization.

Parámetros de entrada

  • org_idstringObligatorio

    The unique identifier for the organization to which the project belongs.

  • project_idstringObligatorio

    The unique identifier for the project whose details are to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the detailed attributes and information of the specified project.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get project membersMEM0_GET_PROJECT_MEMBERSAcción

Retrieves all members for a specified project within an organization.

Parámetros de entrada

  • org_idstringObligatorio

    Unique identifier of the organization.

  • project_idstringObligatorio

    Unique identifier of the project.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get projectsMEM0_GET_PROJECTSAcción

Retrieves all projects for a given organization `org id` to which the caller has access.

Parámetros de entrada

  • org_idstringObligatorio

    The unique identifier of the organization for which to retrieve projects.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the retrieved list of projects and their associated details for the specified organization. The exact structure within this dictionary is determined by the API.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user memory statsMEM0_GET_USER_MEMORY_STATSAcción

Retrieves a summary of the authenticated user's memory activity, including total memories created, search events, and add events.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List entitiesMEM0_LIST_ENTITIES_WITH_OPTIONAL_ORG_AND_PROJECT_FILTERSAcción

Retrieves a list of entities, optionally filtered by organization or project (prefer `org id`/`project id` over deprecated `org name`/`project name`), noting results may be summaries and subject to limits.

Parámetros de entrada

  • org_idstring

    Filter entities by the unique identifier of the organization.

  • org_namestring

    Filter entities by organization name; this field is deprecated, prefer using `org_id` for more stable filtering.

  • project_idstring

    Filter entities by the unique identifier of the project.

  • project_namestring

    Filter entities by project name; this field is deprecated, prefer using `project_id` for more stable filtering.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Perform semantic search on memoriesMEM0_PERFORM_SEMANTIC_SEARCH_ON_MEMORIESAcción

Searches memories semantically using a natural language query (required if `only metadata based search` is false) and/or metadata filters. required: at least one of agent id, user id, app id, or run id must be provided. when `only metadata based search` is true, the `metadata` parameter is required.

Parámetros de entrada

  • querystringObligatorio

    Natural language query to search memories; required if `only_metadata_based_search` is false.

  • top_kinteger

    Maximum number of relevant memory results to return.

  • app_idstring

    Filter memories by application ID.

  • fieldsstring[]

    Specific field names for inclusion in response for each memory; if empty/unprovided, all fields are returned.

  • org_idstring

    Filter memories by organization ID.

  • rerankboolean

    If true, applies an additional reranking step to search results for potentially improved relevance.

  • run_idstring

    Filter memories by run ID.

  • user_idstring

    Filter memories by user ID.

  • agent_idstring

    Filter memories by agent ID.

  • metadataobject

    A dictionary of key-value pairs to filter memories. Only memories matching all key-value pairs in the provided metadata will be returned.

  • org_namestring

    Filter memories by organization name (deprecated; use `org_id` instead).

  • categoriesstring[]

    Filter memories by a list of categories; returns memories matching at least one category.

  • project_idstring

    Filter memories by project ID.

  • project_namestring

    Filter memories by project name (deprecated; use `project_id` instead).

  • output_formatstring

    Specifies the output format for results. 'v1.0' is used if not provided. Supported: 'v1.0', 'v1.1'.

  • filter_memoriesboolean

    If true, strictly applies all provided metadata filters (e.g., `user_id`, `agent_id`, `categories`).

  • only_metadata_based_searchboolean

    If true, search uses only metadata fields, and the `query` field is ignored.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove a member from the organizationMEM0_REMOVE_A_MEMBER_FROM_THE_ORGANIZATIONAcción

Removes a member, specified by their username, from an existing organization of which they are currently a member.

Parámetros de entrada

  • org_idstringObligatorio

    Unique identifier of the organization from which the member will be removed.

  • usernamestringObligatorio

    The username of the member to be removed from the organization.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary which is typically empty or not populated on successful member removal. In case of errors, this field may contain diagnostic details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve all events for the currently logged in userMEM0_RETRIEVE_ALL_EVENTS_FOR_THE_CURRENTLY_LOGGED_IN_USERAcción

Retrieves a paginated list of events for the authenticated user, filterable and paginable via url query parameters. this is a read-only operation that does not modify data. supported query parameters (applied directly to the request url): - `event type` (str, optional): filters events by their type (e.g., 'add', 'search'). - `start date` (str, optional): filters events on or after this date (format: yyyy-mm-dd). - `end date` (str, optional): filters events on or before this date (format: yyyy-mm-dd). - `page` (int, optional): specifies the page number for paginated results. - `page size` (int, optional): number of events per page (default: 50, max: 100).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve entity-specific memoriesMEM0_RETRIEVE_ENTITY_SPECIFIC_MEMORIESAcción

Retrieves all memories (e.g., user preferences, chat history) for a specific entity from the mem0 platform, using its `entity type` and `entity id`; ensure the entity exists.

Parámetros de entrada

  • entity_idstringObligatorio

    The unique identifier of the entity for which memories are to be retrieved.

  • entity_typestringObligatorio

    Type of the entity for which memories are to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    Dictionary of retrieved memories associated with the entity; structure and content vary based on stored information.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve list of memory eventsMEM0_RETRIEVE_LIST_OF_MEMORY_EVENTSAcción

Retrieves a chronological list of all memory events (e.g., user inputs, ai responses) from the mem0 platform, providing interaction history and context for ai assistants.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve memory by idMEM0_RETRIEVE_MEMORY_BY_UNIQUE_IDENTIFIERAcción

Retrieves a complete memory entry by its unique identifier; `memory id` must be valid and for an existing memory.

Parámetros de entrada

  • memory_idstringObligatorio

    Unique identifier of the memory to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Dictionary containing all stored attributes and information of the retrieved memory.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve memory history by idMEM0_RETRIEVE_MEMORY_HISTORY_BY_IDAcción

Retrieves the complete version history for an existing memory, using its unique `memory id`, to inspect its evolution or audit changes.

Parámetros de entrada

  • memory_idstringObligatorio

    Unique identifier of the memory for which history is to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the historical data and changes for the specified memory; its structure varies by memory type and history nature.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve memory listMEM0_RETRIEVE_MEMORY_LISTAcción

Retrieves a list of memories, supporting pagination and diverse filtering (e.g., by ids, metadata, keywords, date ranges); ensure dates are iso 8601 and `page`/`page size` (if used) are positive integers. required: at least one of agent id, user id, app id, or run id must be provided.

Parámetros de entrada

  • pageinteger

    The page number for pagination, starting from 1. Default: 1.

  • app_idstring

    The unique identifier of the application associated with the memories.

  • fieldsstring[]

    A list of specific field names to consider during filtering. This might involve checking for the existence of these fields or scoping other filters (e.g., keywords) to them.

  • org_idstring

    The unique identifier of the organization to filter memories by.

  • run_idstring

    The unique identifier of a specific run or session to filter memories by.

  • user_idstring

    The unique identifier of the user whose memories are to be retrieved.

  • agent_idstring

    The unique identifier of the agent associated with the memories to be retrieved.

  • end_datestring

    The end date (inclusive) for filtering memories, typically in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD').

  • keywordsstring

    Keywords to search for within the memories. The search might be across all text fields or restricted by the `fields` parameter if specified.

  • metadataobject

    A dictionary of key-value pairs to filter memories. Only memories matching all key-value pairs in the provided metadata will be returned.

  • org_namestring

    The name of the organization to filter memories by. This field is deprecated and will be removed in a future version; please use `org_id` instead.

  • page_sizeinteger

    The number of memories to return per page. Default: 100.

  • categoriesstring[]

    A list of categories to filter memories by. Memories matching any of the specified categories will be returned.

  • project_idstring

    The unique identifier of the project to filter memories by.

  • start_datestring

    The start date (inclusive) for filtering memories, typically in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD').

  • project_namestring

    The name of the project to filter memories by. This field is deprecated and will be removed in a future version; please use `project_id` instead.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the retrieved memories, typically under a key like 'items' or 'memories', along with pagination details such as total count, current page, and page size.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search memories with filtersMEM0_SEARCH_MEMORIES_WITH_QUERY_FILTERSAcción

Semantically searches memories using a natural language query and mandatory structured filters, offering options to rerank results and select specific fields; any provided `org id` or `project id` must reference a valid existing entity.

Parámetros de entrada

  • querystringObligatorio

    Natural language query for searching memories; primary text for matching.

  • top_kinteger

    Maximum number of most relevant search results to return.

  • fieldsstring[]

    Specific field names to include in returned memory objects (e.g., 'text', 'source', 'metadata.custom_field'). If omitted, all fields are returned.

  • org_idstring

    UUID of the organization to scope the memory search; preferred over `org_name`.

  • rerankboolean

    If true, applies a secondary reranking model to initial search results for improved relevance.

  • filtersobjectObligatorio

    Filters to refine search results. Keys are fields to filter (e.g., 'user_id', 'metadata.source'). Values are dictionaries specifying the filter operator and value(s) for that field. Supported operators: `AND`, `OR`, `IN`, `gte` (greater than or equal to), `lte` (less than or equal to), `gt` (greater than), `lt` (less than), `ne` (not equal), `icontains` (case-insensitive contains).

  • org_namestring

    Deprecated: Name of the organization to scope the memory search. Use `org_id` instead for improved accuracy and stability.

  • project_idstring

    UUID of the project to scope the memory search; preferred over `project_name`.

  • project_namestring

    Deprecated: Name of the project to scope the memory search. Use `project_id` instead for improved accuracy and stability.

Parámetros de salida

  • dataobjectObligatorio

    Contains the search results, typically including a list of matching memories (e.g., under 'memories' or 'results'), their relevance scores, and search metadata like total hits or pagination.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update memory batch with uuidMEM0_UPDATE_MEMORY_BATCH_WITH_UUIDAcción

Updates text for up to 1000 memories in a single batch, using their uuids.

Parámetros de entrada

  • memoriesobject[]Obligatorio

    List of memory update operations, each specifying a memory ID and its new text.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the response from the batch update operation. This typically includes a status message or details about the success or failure of the updates for each memory.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update memory text contentMEM0_UPDATE_MEMORY_DETAILS_BY_IDAcción

Updates the text content of an existing memory, identified by its `memory id`.

Parámetros de entrada

  • textstring

    New text content to replace the memory's existing text.

  • memory_idstringObligatorio

    The unique identifier of the memory whose text content is to be updated.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update organization member roleMEM0_UPDATE_ORGANIZATION_MEMBER_ROLEAcción

Updates the role of an existing member to a new valid role within an existing organization.

Parámetros de entrada

  • rolestringObligatorio

    New, valid role to assign to the member (e.g., 'admin', 'member').

  • org_idstringObligatorio

    Identifier of the existing organization.

  • usernamestringObligatorio

    Username of the existing member whose role will be updated.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update projectMEM0_UPDATE_PROJECTAcción

Updates a project by `project id` within an `org id`, modifying only provided fields (name, description, custom instructions, custom categories); list fields are fully replaced (cleared by `[]`), other omitted/null fields remain unchanged.

Parámetros de entrada

  • namestring

    New name for the project.

  • org_idstringObligatorio

    Organization's unique identifier.

  • project_idstringObligatorio

    Project's unique identifier to be updated.

  • descriptionstring

    New description for the project.

  • custom_categoriesobject[]

    New list of custom category objects. Fully replaces existing categories; an empty list (`[]`) clears them.

  • custom_instructionsstring[]

    New list of custom instructions to guide memory processing. Fully replaces existing instructions; an empty list (`[]`) clears them.

Parámetros de salida

  • dataobjectObligatorio

    Data of the updated project.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update project member roleMEM0_UPDATE_PROJECT_MEMBER_ROLEAcción

Updates the role of a specific member within a designated project, ensuring the new role is valid and recognized by the system.

Parámetros de entrada

  • rolestringObligatorio

    The new role to assign to the member within the project.

  • org_idstringObligatorio

    Unique identifier of the organization where the project resides.

  • usernamestringObligatorio

    The username of the member whose role is to be updated within the specified project.

  • project_idstringObligatorio

    Unique identifier of the project where the member's role will be updated.

Parámetros de salida

  • dataobjectObligatorio

    A dictionary containing the details of the update operation, typically confirming the successful role change or providing error information.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not