Search | AIsuru Docs

AIsuru Docs

Gets a list of all available memory tags.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

get

GET /memori/v2/MemoryTags/{strSessionID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "memoryTags": [
    "text"
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:21:54.908Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Searches for matching Memory objects.

post

The search is performed using the same algorithm employed in the Text Entered event of the R1 state of the Dialog State Machine.

Path parameters

strSessionIDstringRequired

The session ID

Body

Specifications for a Memory search.

textstring | nullableOptional

Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.

searchTypestring | nullableOptional

How to interpret the search query in the Text property:If "Semantic", the query is interpreted as a full question in natural language, and the search is performed in the same way a question would be posed to the Dialog State Machine.If "Literal", the query is intended as space-separated keywords, and the search is performed by looking for them as a substring in the text and titles of Memories. If omitted the search is Semantic by default. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.

datestring · date-time | nullableOptional

Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

dateUncertaintyDaysnumber · double | nullableOptional

Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeNamestring | nullableOptional

Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLatitudenumber · double | nullableOptional

Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLongitudenumber · double | nullableOptional

Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeUncertaintyKmnumber · double | nullableOptional

Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

tagstring | nullableOptional

Extends or limits the search to Memories associated with a Receiver with this tag, depending on the API called:For Search, Random picking and Memory Hints, the search is extended to Memories associated with a Receiver with this tag. If omitted the search is limited to public Memories. As a special case, if the Giver tag is specified then the search is extended to all Memories, whoever they are associated to.For Filter Memories, the search is limited to Memories associated with a Receiver with this tag.

ignoreLastReadboolean | nullableOptional

If set to True, recently picked Memories will not be deprioritized. This means that a Memory never picked and a Memory picked just moments ago will have the same probability to be picked again. If omitted or set to False, recently picked Memories will be much less probable to be picked again. Used only for Random picking. Ignored for Search, Filter Memories and Memory Hints.

excludedMemoryIDsstring[] | nullableOptional

Optional list of Memory IDs that must be excluded from the search result.

memoryTagsstring[] | nullableOptional

Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.

numberOfResultsinteger · int32 | nullableOptional

Optional number of results. If omitted defaults to 5.

startFrominteger · int32 | nullableOptional

Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.

memoryTypestring | nullableOptional

Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.

withMediaOnlyboolean | nullableOptional

Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.

Responses

200

Success

application/json

post

POST /memori/v2/Search/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 436

{
  "text": "text",
  "searchType": "text",
  "date": "2025-06-07T18:21:54.908Z",
  "dateUncertaintyDays": 1,
  "placeName": "text",
  "placeLatitude": 1,
  "placeLongitude": 1,
  "placeUncertaintyKm": 1,
  "tag": "text",
  "ignoreLastRead": true,
  "excludedMemoryIDs": [
    "text"
  ],
  "contextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "numberOfResults": 1,
  "startFrom": 1,
  "memoryType": "text",
  "withMediaOnly": true
}

200

Success

{
  "count": 1,
  "matches": [
    {
      "memory": {
        "memoryID": "text",
        "memoryType": "text",
        "lastRead": "2025-06-07T18:21:54.908Z",
        "readOccurrences": 1,
        "receiverID": "text",
        "receiverTag": "text",
        "receiverName": "text",
        "media": [
          {
            "mediumID": "text",
            "url": "text",
            "content": "text",
            "mimeType": "text",
            "title": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "creationTimestamp": "2025-06-07T18:21:54.908Z",
            "creationSessionID": "text",
            "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
            "lastChangeSessionID": "text"
          }
        ],
        "title": "text",
        "titleVariants": [
          "text"
        ],
        "answers": [
          {
            "text": "text",
            "preformatted": true,
            "creationTimestamp": "2025-06-07T18:21:54.908Z",
            "creationSessionID": "text",
            "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
            "lastChangeSessionID": "text"
          }
        ],
        "date": "2025-06-07T18:21:54.908Z",
        "dateUncertaintyDays": 1,
        "placeName": "text",
        "placeLatitude": 1,
        "placeLongitude": 1,
        "placeUncertaintyKm": 1,
        "conclusive": true,
        "notPickable": true,
        "help": true,
        "hints": [
          "text"
        ],
        "minTimeout": 1,
        "maxTimeout": 1,
        "contextVarsToSet": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "contextVarsToMatch": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "dcmOutcomeType": "text",
        "dcmOutcomeCode": "text",
        "tags": [
          "text"
        ],
        "creationTimestamp": "2025-06-07T18:21:54.908Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
        "lastChangeSessionID": "text"
      },
      "confidence": 1,
      "confidenceLevel": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:21:54.908Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Searches for matching Memory objects, with pagination.

post

The search is performed using the same algorithm employed in the Text Entered event of the R1 state of the Dialog State Machine. The From and HowMany parameters overwrite the StartFrom and NumberOfResults fields of the SearchQuerySpecs object.

Path parameters

strSessionIDstringRequired

The session ID

frominteger · int32Required

The 0-based index of the first Memory object to list

howManyinteger · int32Required

The number of the Memory objects to list

Body

Specifications for a Memory search.

textstring | nullableOptional

Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.

searchTypestring | nullableOptional

datestring · date-time | nullableOptional

Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

dateUncertaintyDaysnumber · double | nullableOptional

Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeNamestring | nullableOptional

Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLatitudenumber · double | nullableOptional

Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLongitudenumber · double | nullableOptional

Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeUncertaintyKmnumber · double | nullableOptional

Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

tagstring | nullableOptional

ignoreLastReadboolean | nullableOptional

excludedMemoryIDsstring[] | nullableOptional

Optional list of Memory IDs that must be excluded from the search result.

memoryTagsstring[] | nullableOptional

Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.

numberOfResultsinteger · int32 | nullableOptional

Optional number of results. If omitted defaults to 5.

startFrominteger · int32 | nullableOptional

Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.

memoryTypestring | nullableOptional

Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.

withMediaOnlyboolean | nullableOptional

Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.

Responses

200

Success

application/json

post

POST /memori/v2/Search/{strSessionID}/{from}/{howMany} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 436

{
  "text": "text",
  "searchType": "text",
  "date": "2025-06-07T18:21:54.908Z",
  "dateUncertaintyDays": 1,
  "placeName": "text",
  "placeLatitude": 1,
  "placeLongitude": 1,
  "placeUncertaintyKm": 1,
  "tag": "text",
  "ignoreLastRead": true,
  "excludedMemoryIDs": [
    "text"
  ],
  "contextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "numberOfResults": 1,
  "startFrom": 1,
  "memoryType": "text",
  "withMediaOnly": true
}

200

Success

{
  "count": 1,
  "matches": [
    {
      "memory": {
        "memoryID": "text",
        "memoryType": "text",
        "lastRead": "2025-06-07T18:21:54.908Z",
        "readOccurrences": 1,
        "receiverID": "text",
        "receiverTag": "text",
        "receiverName": "text",
        "media": [
          {
            "mediumID": "text",
            "url": "text",
            "content": "text",
            "mimeType": "text",
            "title": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "creationTimestamp": "2025-06-07T18:21:54.908Z",
            "creationSessionID": "text",
            "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
            "lastChangeSessionID": "text"
          }
        ],
        "title": "text",
        "titleVariants": [
          "text"
        ],
        "answers": [
          {
            "text": "text",
            "preformatted": true,
            "creationTimestamp": "2025-06-07T18:21:54.908Z",
            "creationSessionID": "text",
            "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
            "lastChangeSessionID": "text"
          }
        ],
        "date": "2025-06-07T18:21:54.908Z",
        "dateUncertaintyDays": 1,
        "placeName": "text",
        "placeLatitude": 1,
        "placeLongitude": 1,
        "placeUncertaintyKm": 1,
        "conclusive": true,
        "notPickable": true,
        "help": true,
        "hints": [
          "text"
        ],
        "minTimeout": 1,
        "maxTimeout": 1,
        "contextVarsToSet": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "contextVarsToMatch": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "dcmOutcomeType": "text",
        "dcmOutcomeCode": "text",
        "tags": [
          "text"
        ],
        "creationTimestamp": "2025-06-07T18:21:54.908Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
        "lastChangeSessionID": "text"
      },
      "confidence": 1,
      "confidenceLevel": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:21:54.908Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Picks up to 5 random Memory objects.

post

Random picking is performed using the same algorithm employed in the Timeout event of the R1 state of the Dialog State Machine. The algorithm takes into account the Memory's LastRead property, to reduce the chances that a Memory that has just been read is picked up again too soon.

Path parameters

strSessionIDstringRequired

The session ID

Body

Specifications for a Memory search.

textstring | nullableOptional

Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.

searchTypestring | nullableOptional

datestring · date-time | nullableOptional

Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

dateUncertaintyDaysnumber · double | nullableOptional

Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeNamestring | nullableOptional

Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLatitudenumber · double | nullableOptional

Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLongitudenumber · double | nullableOptional

Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeUncertaintyKmnumber · double | nullableOptional

Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

tagstring | nullableOptional

ignoreLastReadboolean | nullableOptional

excludedMemoryIDsstring[] | nullableOptional

Optional list of Memory IDs that must be excluded from the search result.

memoryTagsstring[] | nullableOptional

Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.

numberOfResultsinteger · int32 | nullableOptional

Optional number of results. If omitted defaults to 5.

startFrominteger · int32 | nullableOptional

Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.

memoryTypestring | nullableOptional

Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.

withMediaOnlyboolean | nullableOptional

Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.

Responses

200

Success

application/json

post

POST /memori/v2/Random/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 436

{
  "text": "text",
  "searchType": "text",
  "date": "2025-06-07T18:21:54.908Z",
  "dateUncertaintyDays": 1,
  "placeName": "text",
  "placeLatitude": 1,
  "placeLongitude": 1,
  "placeUncertaintyKm": 1,
  "tag": "text",
  "ignoreLastRead": true,
  "excludedMemoryIDs": [
    "text"
  ],
  "contextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "numberOfResults": 1,
  "startFrom": 1,
  "memoryType": "text",
  "withMediaOnly": true
}

200

Success

{
  "memories": [
    {
      "memoryID": "text",
      "memoryType": "text",
      "lastRead": "2025-06-07T18:21:54.908Z",
      "readOccurrences": 1,
      "receiverID": "text",
      "receiverTag": "text",
      "receiverName": "text",
      "media": [
        {
          "mediumID": "text",
          "url": "text",
          "content": "text",
          "mimeType": "text",
          "title": "text",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "creationTimestamp": "2025-06-07T18:21:54.908Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
          "lastChangeSessionID": "text"
        }
      ],
      "title": "text",
      "titleVariants": [
        "text"
      ],
      "answers": [
        {
          "text": "text",
          "preformatted": true,
          "creationTimestamp": "2025-06-07T18:21:54.908Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
          "lastChangeSessionID": "text"
        }
      ],
      "date": "2025-06-07T18:21:54.908Z",
      "dateUncertaintyDays": 1,
      "placeName": "text",
      "placeLatitude": 1,
      "placeLongitude": 1,
      "placeUncertaintyKm": 1,
      "conclusive": true,
      "notPickable": true,
      "help": true,
      "hints": [
        "text"
      ],
      "minTimeout": 1,
      "maxTimeout": 1,
      "contextVarsToSet": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "contextVarsToMatch": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "dcmOutcomeType": "text",
      "dcmOutcomeCode": "text",
      "tags": [
        "text"
      ],
      "creationTimestamp": "2025-06-07T18:21:54.908Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T18:21:54.908Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:21:54.908Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Picks up to 20 Memory Hint objects.

post

Picking is obtained by searching for Story objects with a date or place set, and clustering dates and places within an uncertainty of at least 1 year or at least 100 km. Each Memory Hint may either suggest a date or a place, but not both.

Path parameters

strSessionIDstringRequired

The session ID

Body

Specifications for a Memory search.

textstring | nullableOptional

Search query. Used only for Search and Filter Memories. Ignored for Random picking and Memory Hints.

searchTypestring | nullableOptional

datestring · date-time | nullableOptional

Approximate date of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

dateUncertaintyDaysnumber · double | nullableOptional

Uncertainty of the date, in days. Required if Date is specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeNamestring | nullableOptional

Name of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLatitudenumber · double | nullableOptional

Latitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeLongitudenumber · double | nullableOptional

Longitude of the approximate place of Memories to limit the search to. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

placeUncertaintyKmnumber · double | nullableOptional

Uncertainty of place, in kilometers. Required if PlaceName or PlaceLatitude and PlaceLongitude are specified. Used for Search, Filter Memories and Random picking. Ignored for Memory Hints.

tagstring | nullableOptional

ignoreLastReadboolean | nullableOptional

excludedMemoryIDsstring[] | nullableOptional

Optional list of Memory IDs that must be excluded from the search result.

memoryTagsstring[] | nullableOptional

Optional list of memory tags. If specified, the search is limited to Memories including ALL the specified tags. Used only for Filter Memories. Ignored for Search, Random picking and Memory Hints.

numberOfResultsinteger · int32 | nullableOptional

Optional number of results. If omitted defaults to 5.

startFrominteger · int32 | nullableOptional

Optional initial result index, 0-based. If omitted defaults to 0. Used for Search, Filter Memories and Memory Hints. Ignored for Random picking.

memoryTypestring | nullableOptional

Optional parameter, if set, filter returns only selected type of memories. Used only for Filter Memories.

withMediaOnlyboolean | nullableOptional

Optional parameter, if set, filter returns only memories that contain media. Used only for Filter Memories.

Responses

200

Success

application/json

post

POST /memori/v2/Hints/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 436

{
  "text": "text",
  "searchType": "text",
  "date": "2025-06-07T18:21:54.908Z",
  "dateUncertaintyDays": 1,
  "placeName": "text",
  "placeLatitude": 1,
  "placeLongitude": 1,
  "placeUncertaintyKm": 1,
  "tag": "text",
  "ignoreLastRead": true,
  "excludedMemoryIDs": [
    "text"
  ],
  "contextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "numberOfResults": 1,
  "startFrom": 1,
  "memoryType": "text",
  "withMediaOnly": true
}

200

Success

{
  "count": 1,
  "memoryHints": [
    {
      "date": "2025-06-07T18:21:54.908Z",
      "dateUncertaintyDays": 1,
      "placeLatitude": 1,
      "placeLongitude": 1,
      "placeUncertaintyKm": 1
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:21:54.908Z",
  "resultCode": 1,
  "resultMessage": "text"
}