Memori

Gets the details of a Memori object by tenant, user and Memori names.

get

Access to Memori objects not belonging to the current logged in user is granted only to administrative users.

Path parameters

tenantNamestringRequired

The name of the Tenant

userNamestringRequired

The name of the User

memoriNamestringRequired

The name of the Memori

strTokenstringOptional

Optional login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/Memori/{tenantName}/{userName}/{memoriName}/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "memori": {
    "memoriID": "text",
    "name": "text",
    "password": "text",
    "recoveryTokens": [
      "text"
    ],
    "newPassword": "text",
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "memoriConfigurationID": "text",
    "description": "text",
    "completionDescription": "text",
    "engineMemoriID": "text",
    "isOwner": true,
    "isGiver": true,
    "isReceiver": true,
    "giverTag": "text",
    "giverPIN": "text",
    "privacyType": "text",
    "secretToken": "text",
    "minimumNumberOfRecoveryTokens": 1,
    "totalNumberOfRecoveryTokens": 1,
    "sentInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "receivedInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "integrations": [
      {
        "integrationID": "text",
        "memoriID": "text",
        "type": "text",
        "state": "text",
        "deviceEmails": [
          "text"
        ],
        "invocationText": "text",
        "jobID": "text",
        "customData": "text",
        "resources": [
          {
            "name": "text",
            "url": "text"
          }
        ],
        "publish": true,
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "avatarURL": "text",
    "coverURL": "text",
    "avatar3DURL": "text",
    "avatarOriginal3DURL": "text",
    "needsPosition": true,
    "needsDateTime": true,
    "voiceType": "text",
    "culture": "text",
    "categories": [
      "text"
    ],
    "nsfw": true,
    "requireLoginToken": true,
    "ageRestriction": 1,
    "exposed": true,
    "mobile": true,
    "confidenceOffset": 1,
    "disableR2R3Loop": true,
    "disableR4Loop": true,
    "disableR5Loop": true,
    "enableCompletions": true,
    "enableDeepThought": true,
    "alwaysAnswerWithCompletion": true,
    "disableCompletionMediaExtraction": true,
    "completionConfigNameForQuestionAnswering": "text",
    "completionConfigForQuestionAnswering": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForImportExport": "text",
    "completionConfigForImportExport": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForDeepThought": "text",
    "completionConfigForDeepThought": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionTemperature": 1,
    "completionMaxTokens": 1,
    "chainingMemoriID": "text",
    "chainingBaseURL": "text",
    "chainingPassword": "text",
    "enableBoardOfExperts": true,
    "enableMacroFunctions": [
      "text"
    ],
    "macroParameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dcmUser": "text",
    "dcmSecret": "text",
    "dcmAppContext": "text",
    "blockedUntil": "2025-06-07T11:51:31.520Z",
    "creationTimestamp": "2025-06-07T11:51:31.520Z",
    "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Memori object by tenant name and user and Memori IDs.

get

Path parameters

tenantNamestringRequired

The name of the Tenant

strUserIDstringRequired

The ID of the User object

strMemoriIDstringRequired

The ID of the Memori object

strTokenstringOptional

Optional login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/MemoriByID/{tenantName}/{strUserID}/{strMemoriID}/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "memori": {
    "memoriID": "text",
    "name": "text",
    "password": "text",
    "recoveryTokens": [
      "text"
    ],
    "newPassword": "text",
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "memoriConfigurationID": "text",
    "description": "text",
    "completionDescription": "text",
    "engineMemoriID": "text",
    "isOwner": true,
    "isGiver": true,
    "isReceiver": true,
    "giverTag": "text",
    "giverPIN": "text",
    "privacyType": "text",
    "secretToken": "text",
    "minimumNumberOfRecoveryTokens": 1,
    "totalNumberOfRecoveryTokens": 1,
    "sentInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "receivedInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "integrations": [
      {
        "integrationID": "text",
        "memoriID": "text",
        "type": "text",
        "state": "text",
        "deviceEmails": [
          "text"
        ],
        "invocationText": "text",
        "jobID": "text",
        "customData": "text",
        "resources": [
          {
            "name": "text",
            "url": "text"
          }
        ],
        "publish": true,
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "avatarURL": "text",
    "coverURL": "text",
    "avatar3DURL": "text",
    "avatarOriginal3DURL": "text",
    "needsPosition": true,
    "needsDateTime": true,
    "voiceType": "text",
    "culture": "text",
    "categories": [
      "text"
    ],
    "nsfw": true,
    "requireLoginToken": true,
    "ageRestriction": 1,
    "exposed": true,
    "mobile": true,
    "confidenceOffset": 1,
    "disableR2R3Loop": true,
    "disableR4Loop": true,
    "disableR5Loop": true,
    "enableCompletions": true,
    "enableDeepThought": true,
    "alwaysAnswerWithCompletion": true,
    "disableCompletionMediaExtraction": true,
    "completionConfigNameForQuestionAnswering": "text",
    "completionConfigForQuestionAnswering": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForImportExport": "text",
    "completionConfigForImportExport": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForDeepThought": "text",
    "completionConfigForDeepThought": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionTemperature": 1,
    "completionMaxTokens": 1,
    "chainingMemoriID": "text",
    "chainingBaseURL": "text",
    "chainingPassword": "text",
    "enableBoardOfExperts": true,
    "enableMacroFunctions": [
      "text"
    ],
    "macroParameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dcmUser": "text",
    "dcmSecret": "text",
    "dcmAppContext": "text",
    "blockedUntil": "2025-06-07T11:51:31.520Z",
    "creationTimestamp": "2025-06-07T11:51:31.520Z",
    "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Memori object of the currently logged in User.

get

Access to Memori objects not belonging to the current logged in user is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/Memori/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "memori": {
    "memoriID": "text",
    "name": "text",
    "password": "text",
    "recoveryTokens": [
      "text"
    ],
    "newPassword": "text",
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "memoriConfigurationID": "text",
    "description": "text",
    "completionDescription": "text",
    "engineMemoriID": "text",
    "isOwner": true,
    "isGiver": true,
    "isReceiver": true,
    "giverTag": "text",
    "giverPIN": "text",
    "privacyType": "text",
    "secretToken": "text",
    "minimumNumberOfRecoveryTokens": 1,
    "totalNumberOfRecoveryTokens": 1,
    "sentInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "receivedInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "integrations": [
      {
        "integrationID": "text",
        "memoriID": "text",
        "type": "text",
        "state": "text",
        "deviceEmails": [
          "text"
        ],
        "invocationText": "text",
        "jobID": "text",
        "customData": "text",
        "resources": [
          {
            "name": "text",
            "url": "text"
          }
        ],
        "publish": true,
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "avatarURL": "text",
    "coverURL": "text",
    "avatar3DURL": "text",
    "avatarOriginal3DURL": "text",
    "needsPosition": true,
    "needsDateTime": true,
    "voiceType": "text",
    "culture": "text",
    "categories": [
      "text"
    ],
    "nsfw": true,
    "requireLoginToken": true,
    "ageRestriction": 1,
    "exposed": true,
    "mobile": true,
    "confidenceOffset": 1,
    "disableR2R3Loop": true,
    "disableR4Loop": true,
    "disableR5Loop": true,
    "enableCompletions": true,
    "enableDeepThought": true,
    "alwaysAnswerWithCompletion": true,
    "disableCompletionMediaExtraction": true,
    "completionConfigNameForQuestionAnswering": "text",
    "completionConfigForQuestionAnswering": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForImportExport": "text",
    "completionConfigForImportExport": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForDeepThought": "text",
    "completionConfigForDeepThought": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionTemperature": 1,
    "completionMaxTokens": 1,
    "chainingMemoriID": "text",
    "chainingBaseURL": "text",
    "chainingPassword": "text",
    "enableBoardOfExperts": true,
    "enableMacroFunctions": [
      "text"
    ],
    "macroParameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dcmUser": "text",
    "dcmSecret": "text",
    "dcmAppContext": "text",
    "blockedUntil": "2025-06-07T11:51:31.520Z",
    "creationTimestamp": "2025-06-07T11:51:31.520Z",
    "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Memori object.

patch

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v2/Memori/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "memori": {
    "memoriID": "text",
    "name": "text",
    "password": "text",
    "recoveryTokens": [
      "text"
    ],
    "newPassword": "text",
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "memoriConfigurationID": "text",
    "description": "text",
    "completionDescription": "text",
    "engineMemoriID": "text",
    "isOwner": true,
    "isGiver": true,
    "isReceiver": true,
    "giverTag": "text",
    "giverPIN": "text",
    "privacyType": "text",
    "secretToken": "text",
    "minimumNumberOfRecoveryTokens": 1,
    "totalNumberOfRecoveryTokens": 1,
    "sentInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "receivedInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "integrations": [
      {
        "integrationID": "text",
        "memoriID": "text",
        "type": "text",
        "state": "text",
        "deviceEmails": [
          "text"
        ],
        "invocationText": "text",
        "jobID": "text",
        "customData": "text",
        "resources": [
          {
            "name": "text",
            "url": "text"
          }
        ],
        "publish": true,
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "avatarURL": "text",
    "coverURL": "text",
    "avatar3DURL": "text",
    "avatarOriginal3DURL": "text",
    "needsPosition": true,
    "needsDateTime": true,
    "voiceType": "text",
    "culture": "text",
    "categories": [
      "text"
    ],
    "nsfw": true,
    "requireLoginToken": true,
    "ageRestriction": 1,
    "exposed": true,
    "mobile": true,
    "confidenceOffset": 1,
    "disableR2R3Loop": true,
    "disableR4Loop": true,
    "disableR5Loop": true,
    "enableCompletions": true,
    "enableDeepThought": true,
    "alwaysAnswerWithCompletion": true,
    "disableCompletionMediaExtraction": true,
    "completionConfigNameForQuestionAnswering": "text",
    "completionConfigForQuestionAnswering": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForImportExport": "text",
    "completionConfigForImportExport": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForDeepThought": "text",
    "completionConfigForDeepThought": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionTemperature": 1,
    "completionMaxTokens": 1,
    "chainingMemoriID": "text",
    "chainingBaseURL": "text",
    "chainingPassword": "text",
    "enableBoardOfExperts": true,
    "enableMacroFunctions": [
      "text"
    ],
    "macroParameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dcmUser": "text",
    "dcmSecret": "text",
    "dcmAppContext": "text",
    "blockedUntil": "2025-06-07T11:51:31.520Z",
    "creationTimestamp": "2025-06-07T11:51:31.520Z",
    "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the statistics for sessions opened in a specified interval for the specified Memori object.

get

Access to Memori objects not belonging to the current logged in user is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

strDateFromstringOptional

The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff

strDateTostringOptional

The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff

Responses

200

Success

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/v2/MemoriSessions/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "totalSessions": 1,
  "validSessions": 1,
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of Memori objects owned by the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v2/Memori/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "memori": [
    {
      "memoriID": "text",
      "name": "text",
      "password": "text",
      "recoveryTokens": [
        "text"
      ],
      "newPassword": "text",
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "memoriConfigurationID": "text",
      "description": "text",
      "completionDescription": "text",
      "engineMemoriID": "text",
      "isOwner": true,
      "isGiver": true,
      "isReceiver": true,
      "giverTag": "text",
      "giverPIN": "text",
      "privacyType": "text",
      "secretToken": "text",
      "minimumNumberOfRecoveryTokens": 1,
      "totalNumberOfRecoveryTokens": 1,
      "sentInvitations": [
        {
          "invitationID": "text",
          "memoriID": "text",
          "engineMemoriID": "text",
          "isInviter": true,
          "isInvitee": true,
          "text": "text",
          "destinationName": "text",
          "destinationEMail": "text",
          "tag": "text",
          "pin": "text",
          "type": "text",
          "state": "text",
          "creationTimestamp": "2025-06-07T11:51:31.520Z",
          "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
        }
      ],
      "receivedInvitations": [
        {
          "invitationID": "text",
          "memoriID": "text",
          "engineMemoriID": "text",
          "isInviter": true,
          "isInvitee": true,
          "text": "text",
          "destinationName": "text",
          "destinationEMail": "text",
          "tag": "text",
          "pin": "text",
          "type": "text",
          "state": "text",
          "creationTimestamp": "2025-06-07T11:51:31.520Z",
          "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
        }
      ],
      "integrations": [
        {
          "integrationID": "text",
          "memoriID": "text",
          "type": "text",
          "state": "text",
          "deviceEmails": [
            "text"
          ],
          "invocationText": "text",
          "jobID": "text",
          "customData": "text",
          "resources": [
            {
              "name": "text",
              "url": "text"
            }
          ],
          "publish": true,
          "creationTimestamp": "2025-06-07T11:51:31.520Z",
          "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
        }
      ],
      "avatarURL": "text",
      "coverURL": "text",
      "avatar3DURL": "text",
      "avatarOriginal3DURL": "text",
      "needsPosition": true,
      "needsDateTime": true,
      "voiceType": "text",
      "culture": "text",
      "categories": [
        "text"
      ],
      "nsfw": true,
      "requireLoginToken": true,
      "ageRestriction": 1,
      "exposed": true,
      "mobile": true,
      "confidenceOffset": 1,
      "disableR2R3Loop": true,
      "disableR4Loop": true,
      "disableR5Loop": true,
      "enableCompletions": true,
      "enableDeepThought": true,
      "alwaysAnswerWithCompletion": true,
      "disableCompletionMediaExtraction": true,
      "completionConfigNameForQuestionAnswering": "text",
      "completionConfigForQuestionAnswering": {
        "completionConfigID": "text",
        "configName": "text",
        "description": "text",
        "provider": "text",
        "endPoint": "text",
        "apiKey": "text",
        "model": "text",
        "questionAnsweringEnabled": true,
        "importExportEnabled": true,
        "deepThoughtEnabled": true,
        "ownerUserID": "text",
        "ownerUserName": "text",
        "ownerTenantName": "text",
        "visibleToTenantUsers": true,
        "visibleToOtherUsers": true,
        "useAsDefault": true,
        "chargeable": true,
        "applyTo": "text"
      },
      "completionConfigNameForImportExport": "text",
      "completionConfigForImportExport": {
        "completionConfigID": "text",
        "configName": "text",
        "description": "text",
        "provider": "text",
        "endPoint": "text",
        "apiKey": "text",
        "model": "text",
        "questionAnsweringEnabled": true,
        "importExportEnabled": true,
        "deepThoughtEnabled": true,
        "ownerUserID": "text",
        "ownerUserName": "text",
        "ownerTenantName": "text",
        "visibleToTenantUsers": true,
        "visibleToOtherUsers": true,
        "useAsDefault": true,
        "chargeable": true,
        "applyTo": "text"
      },
      "completionConfigNameForDeepThought": "text",
      "completionConfigForDeepThought": {
        "completionConfigID": "text",
        "configName": "text",
        "description": "text",
        "provider": "text",
        "endPoint": "text",
        "apiKey": "text",
        "model": "text",
        "questionAnsweringEnabled": true,
        "importExportEnabled": true,
        "deepThoughtEnabled": true,
        "ownerUserID": "text",
        "ownerUserName": "text",
        "ownerTenantName": "text",
        "visibleToTenantUsers": true,
        "visibleToOtherUsers": true,
        "useAsDefault": true,
        "chargeable": true,
        "applyTo": "text"
      },
      "completionTemperature": 1,
      "completionMaxTokens": 1,
      "chainingMemoriID": "text",
      "chainingBaseURL": "text",
      "chainingPassword": "text",
      "enableBoardOfExperts": true,
      "enableMacroFunctions": [
        "text"
      ],
      "macroParameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "dcmUser": "text",
      "dcmSecret": "text",
      "dcmAppContext": "text",
      "blockedUntil": "2025-06-07T11:51:31.520Z",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Registers a new Memori object.

post

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/Memori/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "memori": {
    "memoriID": "text",
    "name": "text",
    "password": "text",
    "recoveryTokens": [
      "text"
    ],
    "newPassword": "text",
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "memoriConfigurationID": "text",
    "description": "text",
    "completionDescription": "text",
    "engineMemoriID": "text",
    "isOwner": true,
    "isGiver": true,
    "isReceiver": true,
    "giverTag": "text",
    "giverPIN": "text",
    "privacyType": "text",
    "secretToken": "text",
    "minimumNumberOfRecoveryTokens": 1,
    "totalNumberOfRecoveryTokens": 1,
    "sentInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "receivedInvitations": [
      {
        "invitationID": "text",
        "memoriID": "text",
        "engineMemoriID": "text",
        "isInviter": true,
        "isInvitee": true,
        "text": "text",
        "destinationName": "text",
        "destinationEMail": "text",
        "tag": "text",
        "pin": "text",
        "type": "text",
        "state": "text",
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "integrations": [
      {
        "integrationID": "text",
        "memoriID": "text",
        "type": "text",
        "state": "text",
        "deviceEmails": [
          "text"
        ],
        "invocationText": "text",
        "jobID": "text",
        "customData": "text",
        "resources": [
          {
            "name": "text",
            "url": "text"
          }
        ],
        "publish": true,
        "creationTimestamp": "2025-06-07T11:51:31.520Z",
        "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
      }
    ],
    "avatarURL": "text",
    "coverURL": "text",
    "avatar3DURL": "text",
    "avatarOriginal3DURL": "text",
    "needsPosition": true,
    "needsDateTime": true,
    "voiceType": "text",
    "culture": "text",
    "categories": [
      "text"
    ],
    "nsfw": true,
    "requireLoginToken": true,
    "ageRestriction": 1,
    "exposed": true,
    "mobile": true,
    "confidenceOffset": 1,
    "disableR2R3Loop": true,
    "disableR4Loop": true,
    "disableR5Loop": true,
    "enableCompletions": true,
    "enableDeepThought": true,
    "alwaysAnswerWithCompletion": true,
    "disableCompletionMediaExtraction": true,
    "completionConfigNameForQuestionAnswering": "text",
    "completionConfigForQuestionAnswering": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForImportExport": "text",
    "completionConfigForImportExport": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionConfigNameForDeepThought": "text",
    "completionConfigForDeepThought": {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    },
    "completionTemperature": 1,
    "completionMaxTokens": 1,
    "chainingMemoriID": "text",
    "chainingBaseURL": "text",
    "chainingPassword": "text",
    "enableBoardOfExperts": true,
    "enableMacroFunctions": [
      "text"
    ],
    "macroParameters": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dcmUser": "text",
    "dcmSecret": "text",
    "dcmAppContext": "text",
    "blockedUntil": "2025-06-07T11:51:31.520Z",
    "creationTimestamp": "2025-06-07T11:51:31.520Z",
    "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes an existing Memori object.

delete

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v2/Memori/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Transfers an existing Memori object to another User. The new owner must be specified by either a OwnerUserID or a OwnerUserName-OwnerTenantName pair. The OwnerUserName may also specify a user e-mail.

post

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/TransferMemori/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Block Memori

post

Only super admins are admitted to perform this operation

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/MemoriBlock/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Unblock Memori

delete

Only super admins are admitted to perform this operation

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Memori object.

memoriIDstring | nullableOptional

Memori ID. Unique and assigned by the system. Returned during Registration and Get operations. Used in Update, Transfer and Delete operations. Ignored in other cases.

namestring | nullableOptional

Memori name. Required during Registration operations. Used during Update operations. Returned during Get operations.

passwordstring | nullableOptional

Password. Required during Registration operations. May be required during Update operations. Ignored in other cases. Must be provided in the following cases: When PrivacyType is SECRET: during Registration and Update operations, and it can be any non-empty string When PrivacyType is PRIVATE: only during Update operations, and it must be set with the SecretToken provided during registration

recoveryTokensstring[] | nullableOptional

Recovery tokens. Returned during Registration operations if the Memori Privacy Type is set to SECRET and a TotalNumberOfRecoveryTokens is greater than 0. Ignored in other cases.

newPasswordstring | nullableOptional

New password. Used during Update operations. Ignored in other cases. Can be provided in the following case: When PrivacyType is SECRET: during Update operations, and it can be any non-empty string

ownerUserIDstring | nullableOptional

ID of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Memori belongs to. Returned during Registration and Get operations. Used in Transfer operation. Ignored in other cases.

memoriConfigurationIDstring | nullableOptional

Memori configuration ID. Required during Registration. Returned during Get operations.

descriptionstring | nullableOptional

Memori description. Required during Registration and Update operations. Returned during Get operations.

completionDescriptionstring | nullableOptional

Memori description for completions. If specified, it is used in place of Description when obtaining a completion via a generative AI. May be specified during Registration and Update operations. Returned during Get operations.

engineMemoriIDstring | nullableOptional

ID of the corresponding object on the Memori Engine. Returned during Get operations. Ignored in other cases.

isOwnerbooleanOptional

True if the requesting User is the owner of this Memori, and as such has admin (update and delete) access to this Memori. Returned during Get operations. Ignored in other cases.

isGiverbooleanOptional

True if the requesting User has Giver (full read and write) access to this Memori. Returned during Get operations. Ignored in other cases.

isReceiverbooleanOptional

True if the requesting User has Receiver (special read only) access to this Memori. Returned during Get operations. Ignored in other cases.

giverTagstring | nullableOptional

The tag of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

giverPINstring | nullableOptional

The PIN of the Giver of this Memori. Returned during Registration and Get operations. Used Update operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User.

privacyTypestring | nullableOptional

Type of privacy setting for this Memori (private, public or secret). Required during Registration operations. Used during Update operations. Returned during Get operations. May be one of the following: PUBLIC: this Memori is not encrypted, has no password and is accessible to everyone PRIVATE: this Memori is not encrypted, has a system-generated Secret Token as password and can be accessed only by providing it SECRET: this Memori is encrypted, has a user-defined password and can be accessed only by providing it

secretTokenstring | nullableOptional

Secret Token. Assigned by the system. Must be used as Password when the PrivacyType is PRIVATE. Returned during Open Session and Get operations. May be required during Update operations. Ignored in other cases. It is present only if this Memori is accessible to the logged in User (e.g. they are the owner or a legitimate Giver or Receiver) and its Privacy Type is set to PRIVATE.

minimumNumberOfRecoveryTokensinteger · int32 | nullableOptional

Minium number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. May be provided during Registration operations. Returned during Get operations. Ignored in other cases. It is present only if this Memori belongs to the logged in User and its Privacy Type is set to SECRET.

totalNumberOfRecoveryTokensinteger · int32 | nullableOptional

Total number of recovery tokens. Recovery tokens allow to access a secret Memori when its original password has been lost. If set, a set of recovery tokens will be generated and returned after Registration completes.

avatarURLstring | nullableOptional

URL of the avatar image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

coverURLstring | nullableOptional

URL of the cover image represting this Memori object. May be provided during Registration and Update operations. Returned during Get operations.

avatar3DURLstring | nullableOptional

URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

avatarOriginal3DURLstring | nullableOptional

Original URL of the avatar 3D model represting this Memori object. It is obtained from the CustomData property of the public home page Integration object for this Memori, if present. To be changed, the Integration object must be changed. Returned during Get operations. Ignored in other cases.

needsPositionboolean | nullableOptional

True if this Memori requires positioning to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

needsDateTimeboolean | nullableOptional

True if this Memori requires current date/time to be accessed. May be provided during Registration and Update operations. Returned during Get operations.

voiceTypestring | nullableOptional

Type of voice for this Memori (male or female). May be provided during Registration and Update operations. Returned during Get operations. Can be one of the following: MALE: standard male voice FEMALE: standard female voice

culturestring | nullableOptional

Culture for dialogs and natural language processing of this Memori. Returned during Get operations. Ignored in other cases. Currently supported cultures are: it-IT en-US

categoriesstring[] | nullableOptional

Categories (or tags) associated with this Memori. May be provided during Registration and Update operations. Returned during Get operations.

nsfwboolean | nullableOptional

True if this Memori content must be considered not safe for minors of working environments. May be provided during Registration and Update operations. Returned during Get operations.

requireLoginTokenboolean | nullableOptional

When True, a Giver Tag/Pin or a valid login token is needed to open a session

ageRestrictioninteger · int32Optional

The minimum age required to open a session to this Memori. Returned during Get operations. Ignored in other cases.

exposedboolean | nullableOptional

True if this Memori must be exposed on the homepage of its corresponding owner User's tenant. May be provided during Registration and Update operations. Returned during Get operations.

mobileboolean | nullableOptional

True if this Memori must be accessible from the mobile app. May be provided during Registration and Update operations. Returned during Get operations.

confidenceOffsetnumber · float | nullableOptional

The offset to be applied to confidence levels. Typically, in the range from -0.02 to 0.02.

disableR2R3Loopboolean | nullableOptional

True if this Memori must skip the R2-R3 loop, i.e. must consider medium confidence answers as high confidence answers in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR4Loopboolean | nullableOptional

True if this Memori must skip the R4 loop, i.e. must not propose randomly picked contents when a Time Out event is received in R1. May be provided during Registration and Update operations. Returned during Get operations.

disableR5Loopboolean | nullableOptional

True if this Memori must skip the R5 loop, i.e. must not accept the "not what I asked" intent in R1. May be provided during Registration and Update operations. Returned during Get operations.

enableCompletionsboolean | nullableOptional

True if this Memori must try to answer using completions from a Large Language Model, if available, when no other answers are available.

enableDeepThoughtboolean | nullableOptional

If set to True this Memori will collect known facts about the user on a special long term memory and makes use of it to improve the conversation. Requires EnableCompletions to be set to True to work appropriately.

alwaysAnswerWithCompletionboolean | nullableOptional

If set to True this Memori will always try to answer with a completion. Memory objects will be used for generative AI prompting, but not for direct answers. Requires EnableCompletions to be set to True to work appropriately. Can't be used in conjunction with the Chaining feature. May be provided during Registration and Update operations. Returned during Get operations.

disableCompletionMediaExtractionboolean | nullableOptional

If set to True this Memori will not try to extract related media when generating a response through a completion with generative AI. This flag has no effect to user-generated content: attached media will always be provided. May be provided during Registration and Update operations. Returned during Get operations.

completionConfigNameForQuestionAnsweringstring | nullableOptional

Name of the Completion Configuration used for Question Answering with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForImportExportstring | nullableOptional

Name of the Completion Configuration used for Import/Export with a Large Language Model. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionConfigNameForDeepThoughtstring | nullableOptional

Name of the Completion Configuration used for Deep Thought. If null the default is used. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set configuration.

completionTemperaturenumber · float | nullableOptional

Temperature for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

completionMaxTokensinteger · int32 | nullableOptional

Maximum number of output tokens for Completions. If not set a default is used. May be provided during Registration and Update operations. Returned during Get operations.

chainingMemoriIDstring | nullableOptional

Optional Engine ID of a chained Memori. If set, any time this Memori can't find an answer to a question, it will try to ask to the chained Memori. The chained Memori will then answer and transparently handle the subsequent dialog. The user will not be aware of chaining. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set chaining.

chainingBaseURLstring | nullableOptional

Optional base URL of a chained Memori, typically https://engine.memori.ai/. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Returned during Get operations.

chainingPasswordstring | nullableOptional

Password of the chained Memori. Required if ChainingMemoriID is set. May be provided during Registration and Update operations. Ignored in other cases.

enableBoardOfExpertsboolean | nullableOptional

If set to True this Memori will act as the chairman of a board of experts, i.e. for each question will determine which expert is competent and forward the question to it. At least an Expert Reference must then be provided for this feature to activate.

enableMacroFunctionsstring[] | nullableOptional

List of Macro Function names enabled for this Memori. Currently available Macro Functions are: Wikipedia: adds functions to search for a topic on Wikipedia URLCrawling: adds functions to crawl a web page ContextVariables: adds functions to manage context variables

dcmUserstring | nullableOptional

User name of the optional integration with the DCM platform. If set, this Memori will be able send outcomes to the DCM platform when specific contents are emitted during the conversation. May be provided during Registration and Update operations. Returned during Get operations. When updating, set it to a single dash character (-) to remove a previously set integration.

dcmSecretstring | nullableOptional

Shared secret of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Ignored in other cases.

dcmAppContextstring | nullableOptional

Application context of the optional integration with the DCM platform. Required if DCMUser is set. May be provided during Registration and Update operations. Returned during Get operations.

blockedUntilstring · date-time | nullableOptional

Administrative block end date. Null if no administrative block is in effect. During an administrative block a Memori can be edited with a Giver session, but not accessed with an anonymous or Receiver session.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v2/MemoriBlock/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 3838

{
  "memoriID": "text",
  "name": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "newPassword": "text",
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "memoriConfigurationID": "text",
  "description": "text",
  "completionDescription": "text",
  "engineMemoriID": "text",
  "isOwner": true,
  "isGiver": true,
  "isReceiver": true,
  "giverTag": "text",
  "giverPIN": "text",
  "privacyType": "text",
  "secretToken": "text",
  "minimumNumberOfRecoveryTokens": 1,
  "totalNumberOfRecoveryTokens": 1,
  "sentInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "receivedInvitations": [
    {
      "invitationID": "text",
      "memoriID": "text",
      "engineMemoriID": "text",
      "isInviter": true,
      "isInvitee": true,
      "text": "text",
      "destinationName": "text",
      "destinationEMail": "text",
      "tag": "text",
      "pin": "text",
      "type": "text",
      "state": "text",
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T11:51:31.520Z",
      "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
    }
  ],
  "avatarURL": "text",
  "coverURL": "text",
  "avatar3DURL": "text",
  "avatarOriginal3DURL": "text",
  "needsPosition": true,
  "needsDateTime": true,
  "voiceType": "text",
  "culture": "text",
  "categories": [
    "text"
  ],
  "nsfw": true,
  "requireLoginToken": true,
  "ageRestriction": 1,
  "exposed": true,
  "mobile": true,
  "confidenceOffset": 1,
  "disableR2R3Loop": true,
  "disableR4Loop": true,
  "disableR5Loop": true,
  "enableCompletions": true,
  "enableDeepThought": true,
  "alwaysAnswerWithCompletion": true,
  "disableCompletionMediaExtraction": true,
  "completionConfigNameForQuestionAnswering": "text",
  "completionConfigForQuestionAnswering": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForImportExport": "text",
  "completionConfigForImportExport": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionConfigNameForDeepThought": "text",
  "completionConfigForDeepThought": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "completionTemperature": 1,
  "completionMaxTokens": 1,
  "chainingMemoriID": "text",
  "chainingBaseURL": "text",
  "chainingPassword": "text",
  "enableBoardOfExperts": true,
  "enableMacroFunctions": [
    "text"
  ],
  "macroParameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dcmUser": "text",
  "dcmSecret": "text",
  "dcmAppContext": "text",
  "blockedUntil": "2025-06-07T11:51:31.520Z",
  "creationTimestamp": "2025-06-07T11:51:31.520Z",
  "lastChangeTimestamp": "2025-06-07T11:51:31.520Z"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T11:51:31.520Z",
  "resultCode": 1,
  "resultMessage": "text"
}