CorrelationPairs

Lists all Correlation Pair objects.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

get

/memori/v2/CorrelationPairs/{strSessionID}

HTTPcURLJavaScriptPython

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

200

Success

{
  "count": 1,
  "correlationPairs": [
    {
      "pairID": "text",
      "text1": "text",
      "text2": "text",
      "correlated": true,
      "occurrences": 1,
      "creationTimestamp": "2026-01-20T09:21:49.008Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2026-01-20T09:21:49.008Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-01-20T09:21:49.008Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Correlation Pair objects with pagination.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

frominteger · int32Required

The 0-based index of the first Correlation Pair object to list

howManyinteger · int32Required

The number of the Correlation Pair objects to list

Responses

200

Success

application/json

get

/memori/v2/CorrelationPairs/{strSessionID}/{from}/{howMany}

HTTPcURLJavaScriptPython

GET /memori/v2/CorrelationPairs/{strSessionID}/{from}/{howMany} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "count": 1,
  "correlationPairs": [
    {
      "pairID": "text",
      "text1": "text",
      "text2": "text",
      "correlated": true,
      "occurrences": 1,
      "creationTimestamp": "2026-01-20T09:21:49.008Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2026-01-20T09:21:49.008Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-01-20T09:21:49.008Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Adds a new Correlation Pair object.

post

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Body

application/json

pairIDstring | nullableOptional

Correlation Pair object ID.

text1string | nullableOptional

First text of the Correlation Pair, typically a question coming from a Receiver.

text2string | nullableOptional

Second text of the Correlation Pair, typically the original question introduced by the Giver.

correlatedbooleanOptional

True if the texts must be considered correlated.

occurrencesinteger · int32Optional

Number of times these the first text has been correlated to the second.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.

creationSessionIDstring | nullableOptional

ID of the session that created this object.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.

lastChangeSessionIDstring | nullableOptional

ID of the latest session that changed this object.

Responses

200

Success

application/json

post

/memori/v2/CorrelationPair/{strSessionID}

HTTPcURLJavaScriptPython

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

{
  "pairID": "text",
  "text1": "text",
  "text2": "text",
  "correlated": true,
  "occurrences": 1,
  "creationTimestamp": "2026-01-20T09:21:49.008Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2026-01-20T09:21:49.008Z",
  "lastChangeSessionID": "text"
}

200

Success

{
  "correlationPairID": "text",
  "requestID": 1,
  "requestDateTime": "2026-01-20T09:21:49.008Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Correlation Pair object.

delete

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

strPairIDstringRequired

The Correlation Pair object ID

Responses

200

Success

application/json

delete

/memori/v2/CorrelationPair/{strSessionID}/{strPairID}

HTTPcURLJavaScriptPython

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

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-01-20T09:21:49.008Z",
  "resultCode": 1,
  "resultMessage": "text"
}