Session

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

post

Body

application/json

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. When ContinueFromChatLogID is specified, Tag and PIN must match those in use in the Chat Log when the session was saved.

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. When ContinueFromChatLogID is specified, Tag and PIN must match those in use in the Chat Log when the session was saved.

initialQuestionstring · nullableOptional

Optional initial question. It is sent as a Text Entered Event to the Dialog State Machine if the state session opening is R1. When ContinueFromChatLogID is specified, InitialQuestion is ignored.

continueFromChatLogIDstring · nullableOptional

Optional ID of an existing Chat Log for this Memori object, from which the session and the conversation should continue. When specified, InitialContextVars and InitialQuestion are ignored. Additionally, the Tag and PIN properties must match those in use in the Chat Log when the session was saved.

continueFromSessionIDstring · nullableOptional

Optional ID of an existing Session ID for this Memori object, from which the session and the conversation should continue. When specified, InitialContextVars and InitialQuestion are ignored. Additionally, the Tag and PIN properties must match those in use in the Chat Log when the session was saved.

birthDatestring · date-time · nullableOptional

Birthdate 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

Response of an Open Session request.

sessionIDstring · nullableOptional

Session ID.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post

/memori/v2/Session

HTTPcURLJavaScriptPython

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

{
  "memoriID": "text",
  "password": "text",
  "recoveryTokens": [
    "text"
  ],
  "tag": "text",
  "pin": "text",
  "initialContextVars": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "initialQuestion": "text",
  "continueFromChatLogID": "text",
  "continueFromSessionID": "text",
  "birthDate": "2026-03-06T17:14:17.524Z",
  "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": "2026-03-06T17:14:17.524Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2026-03-06T17:14:17.524Z",
        "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": "2026-03-06T17:14:17.524Z",
    "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": "2026-03-06T17:14:17.524Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2026-03-06T17:14:17.524Z",
        "lastChangeSessionID": "text"
      }
    ],
    "contextVars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "memoryTags": [
      "text"
    ]
  },
  "requestID": 1,
  "requestDateTime": "2026-03-06T17:14:17.524Z",
  "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

Base response for requests reporting or affecting the Dialog State Machine's state.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/Session/{strSessionID}

HTTPcURLJavaScriptPython

GET /memori/v2/Session/{strSessionID} HTTP/1.1
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": "2026-03-06T17:14:17.524Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2026-03-06T17:14:17.524Z",
        "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": "2026-03-06T17:14:17.524Z",
    "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": "2026-03-06T17:14:17.524Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2026-03-06T17:14:17.524Z",
        "lastChangeSessionID": "text"
      }
    ],
    "contextVars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "memoryTags": [
      "text"
    ]
  },
  "requestID": 1,
  "requestDateTime": "2026-03-06T17:14:17.524Z",
  "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

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

delete

/memori/v2/Session/{strSessionID}

HTTPcURLJavaScriptPython

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

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-03-06T17:14:17.524Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Checks if a session is valid (exists and is not in terminal state)

get

Path parameters

strSessionIDstringRequired

The session ID to check

Responses

200

Success

application/json

Response for session validity check requests.

isValidbooleanOptional

Indicates whether the session is valid (exists and is not in terminal state Z0).

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/Session/{strSessionID}/IsValid

HTTPcURLJavaScriptPython

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

200

Success

{
  "isValid": true,
  "requestID": 1,
  "requestDateTime": "2026-03-06T17:14:17.524Z",
  "resultCode": 1,
  "resultMessage": "text"
}