Session

Initializes a new Dialog State Machine session for an existing Memori.

post

Body

Specifications for a Session Open request.

memoriIDstring | nullableOptional

The Memori object ID. Required.

passwordstring | nullableOptional

Password. As an alternative the minimum number of recovery tokens can be supplied in the RecoveryTokens property. If the Memori is public no password is required.

recoveryTokensstring[] | nullableOptional

Recovery tokens, as an alternative to the Memori's password. Must be supplied in the minimum number set during Memori registration.

tagstring | nullableOptional

Optional initial tag. If specified the PIN property must also be specified. The Dialog State Machine will try to transition to the corresponding Giver or Receiver automatically. Transition may fail if Tag or PIN are incorrect, or if the Giver or Receiver have not been set up yet.

pinstring | nullableOptional

Optional PIN corresponding to the initial tag, expressed as a 6-digit number between 000000 and 999999. Must be specified if the Tag property is specified.

initialQuestionstring | nullableOptional

Optional initial question. It is send as a Text Entered Event to the Dialog State Machine if the state session opening is R1.

birthDatestring · date-time | nullableOptional

Birth date of the user. Age verification may be applied when Memori content is NSFW or makes use of completions. If a login token is specified in the Additional Info field, the user's birth date obtained from the login token overrides whatever value is specified here. This value is never stored.

maintenanceCodestring | nullableOptional

For internal use only.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /memori/v2/Session HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "memoriID": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "tag": "text",
  "pin": "text",
  "initialContextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "initialQuestion": "text",
  "birthDate": "2025-06-07T19:32:03.025Z",
  "maintenanceCode": "text",
  "additionalInfo": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

Success

{
  "sessionID": "text",
  "currentState": {
    "state": "text",
    "stateName": "text",
    "previousState": "text",
    "confidence": 1,
    "confidenceLevel": "text",
    "emission": "text",
    "emittedMedia": [
      {
        "mediumID": "text",
        "url": "text",
        "content": "text",
        "mimeType": "text",
        "title": "text",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "creationTimestamp": "2025-06-07T19:32:03.025Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T19:32:03.025Z",
        "lastChangeSessionID": "text"
      }
    ],
    "continuationEmitted": true,
    "emitter": "text",
    "completion": true,
    "acceptsTimeout": true,
    "acceptsAbort": true,
    "acceptsMedia": true,
    "acceptsDate": true,
    "acceptsPlace": true,
    "acceptsTag": true,
    "acceptsFeedback": true,
    "hints": [
      "text"
    ],
    "timeout": 1,
    "currentTag": "text",
    "currentTagAuthenticated": true,
    "currentDate": "2025-06-07T19:32:03.025Z",
    "currentPlaceName": "text",
    "currentLatitude": 1,
    "currentLongitude": 1,
    "currentUncertaintyKm": 1,
    "currentMemoryID": "text",
    "lastMatchedMemoryID": "text",
    "currentMedia": [
      {
        "mediumID": "text",
        "url": "text",
        "content": "text",
        "mimeType": "text",
        "title": "text",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "creationTimestamp": "2025-06-07T19:32:03.025Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T19:32:03.025Z",
        "lastChangeSessionID": "text"
      }
    ],
    "contextVars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "memoryTags": [
      "text"
    ]
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:32:03.025Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Returns the current state of a session's Dialog State Machine.

get

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

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

200

Success

{
  "currentState": {
    "state": "text",
    "stateName": "text",
    "previousState": "text",
    "confidence": 1,
    "confidenceLevel": "text",
    "emission": "text",
    "emittedMedia": [
      {
        "mediumID": "text",
        "url": "text",
        "content": "text",
        "mimeType": "text",
        "title": "text",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "creationTimestamp": "2025-06-07T19:32:03.025Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T19:32:03.025Z",
        "lastChangeSessionID": "text"
      }
    ],
    "continuationEmitted": true,
    "emitter": "text",
    "completion": true,
    "acceptsTimeout": true,
    "acceptsAbort": true,
    "acceptsMedia": true,
    "acceptsDate": true,
    "acceptsPlace": true,
    "acceptsTag": true,
    "acceptsFeedback": true,
    "hints": [
      "text"
    ],
    "timeout": 1,
    "currentTag": "text",
    "currentTagAuthenticated": true,
    "currentDate": "2025-06-07T19:32:03.025Z",
    "currentPlaceName": "text",
    "currentLatitude": 1,
    "currentLongitude": 1,
    "currentUncertaintyKm": 1,
    "currentMemoryID": "text",
    "lastMatchedMemoryID": "text",
    "currentMedia": [
      {
        "mediumID": "text",
        "url": "text",
        "content": "text",
        "mimeType": "text",
        "title": "text",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "creationTimestamp": "2025-06-07T19:32:03.025Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T19:32:03.025Z",
        "lastChangeSessionID": "text"
      }
    ],
    "contextVars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "memoryTags": [
      "text"
    ]
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:32:03.025Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Closes the session and disposes of its Dialog State Machine.

delete

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /memori/v2/Session/{strSessionID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:32:03.025Z",
  "resultCode": 1,
  "resultMessage": "text"
}