ImportExport

Starts an Import process for memories from a CSV file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications and content for an Import CSV request.

conclusivebooleanOptional

If True all the imported questions will have the Conclusive flag set.

notPickablebooleanOptional

If True all the imported questions will have the NotPickable flag set.

memoryTagsstring[] | nullableOptional

If set, all imported questions will have the MemoryTags property set to these values.

receiverIDstring | nullableOptional

If set, all the imported questions will be associated with the specified receiver. Must be an existing receiver ID.

addMediaLinkstring | nullableOptional

If set, all the imported questions will have an additional medium with the specified link.

linkTitleHandlingstring | nullableOptional

Specifications for the TXT import. Can be one of the following: FixedTitle: the title of the link will be the one specified in LinkTitleHandling or "Link" if not set FetchFromUrl: the title of the link will be the one fetched from the URL Hostname: the title of the link will be the hostname of the URL

linkTitlestring | nullableOptional

The title of the links to be added to the imported questions, it will be used "Link" if not set

rowsstring[] | nullableOptional

Rows of the file to be imported. Required. Except when importing an agent, in which case this field must be left empty.

importNamestring | nullableOptional

Optional name of this import.

forceImportbooleanOptional

Specifies if questions having a high similarity with already stored questions have to be imported. If true, all questions are imported without checking the similarity.

notesstring | nullableOptional

Additional notes about the import.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 619

{
  "csvSpecs": {
    "newLine": "text",
    "hasHeaders": true,
    "headerNames": [
      "text"
    ],
    "questionColumnName": "text",
    "answerColumnName": "text",
    "contextVarsToMatchColumnName": "text",
    "contextVarsToSetColumnName": "text",
    "memoryTagsColumnName": "text",
    "csvSeparator": "text",
    "questionTitleVariantsSeparator": "text"
  },
  "conclusive": true,
  "notPickable": true,
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToMatch": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "receiverID": "text",
  "addMediaLink": "text",
  "linkTitleHandling": "text",
  "linkTitle": "text",
  "rows": [
    "text"
  ],
  "importName": "text",
  "forceImport": true,
  "notes": "text"
}

200

Success

{
  "status": {
    "importType": "text",
    "importSize": 1,
    "importName": "text",
    "importedMemories": 1,
    "importWarningsCount": 1,
    "importWarnings": [
      {
        "warningType": "text",
        "rowNumber": 1,
        "text": "text",
        "similarTexts": [
          {
            "text": "text",
            "similarityLevel": "text"
          }
        ]
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2025-06-07T15:19:19.973Z",
    "end": "2025-06-07T15:19:19.973Z",
    "eta": 1,
    "creationTimestamp": "2025-06-07T15:19:19.973Z",
    "lastChangeTimestamp": "2025-06-07T15:19:19.973Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:19:19.973Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Starts an Import process for memories from a TXT file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications and content for an Import TXT request.

conclusivebooleanOptional

If True all the imported questions will have the Conclusive flag set.

notPickablebooleanOptional

If True all the imported questions will have the NotPickable flag set.

memoryTagsstring[] | nullableOptional

If set, all imported questions will have the MemoryTags property set to these values.

receiverIDstring | nullableOptional

If set, all the imported questions will be associated with the specified receiver. Must be an existing receiver ID.

addMediaLinkstring | nullableOptional

If set, all the imported questions will have an additional medium with the specified link.

linkTitleHandlingstring | nullableOptional

Specifications for the TXT import. Can be one of the following: FixedTitle: the title of the link will be the one specified in LinkTitleHandling or "Link" if not set FetchFromUrl: the title of the link will be the one fetched from the URL Hostname: the title of the link will be the hostname of the URL

linkTitlestring | nullableOptional

The title of the links to be added to the imported questions, it will be used "Link" if not set

rowsstring[] | nullableOptional

Rows of the file to be imported. Required. Except when importing an agent, in which case this field must be left empty.

importNamestring | nullableOptional

Optional name of this import.

forceImportbooleanOptional

Specifies if questions having a high similarity with already stored questions have to be imported. If true, all questions are imported without checking the similarity.

notesstring | nullableOptional

Additional notes about the import.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "txtSpecs": {
    "granularity": "text",
    "questionsGenerationInstructions": "text",
    "attachSource": true,
    "sourceAttachmentTitle": "text"
  },
  "conclusive": true,
  "notPickable": true,
  "contextVarsToSet": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contextVarsToMatch": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "memoryTags": [
    "text"
  ],
  "receiverID": "text",
  "addMediaLink": "text",
  "linkTitleHandling": "text",
  "linkTitle": "text",
  "rows": [
    "text"
  ],
  "importName": "text",
  "forceImport": true,
  "notes": "text"
}

200

Success

{
  "status": {
    "importType": "text",
    "importSize": 1,
    "importName": "text",
    "importedMemories": 1,
    "importWarningsCount": 1,
    "importWarnings": [
      {
        "warningType": "text",
        "rowNumber": 1,
        "text": "text",
        "similarTexts": [
          {
            "text": "text",
            "similarityLevel": "text"
          }
        ]
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2025-06-07T15:19:19.973Z",
    "end": "2025-06-07T15:19:19.973Z",
    "eta": 1,
    "creationTimestamp": "2025-06-07T15:19:19.973Z",
    "lastChangeTimestamp": "2025-06-07T15:19:19.973Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:19:19.973Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Starts an Import process for functions and intents from a jsonl file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications for an Import Functions/Intents request.

rowsstring[] | nullableOptional

Rows of the file to be imported. Required. Except when importing an agent, in which case this field must be left empty.

importNamestring | nullableOptional

Optional name of this import.

forceImportbooleanOptional

Specifies if questions having a high similarity with already stored questions have to be imported. If true, all questions are imported without checking the similarity.

notesstring | nullableOptional

Additional notes about the import.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "rows": [
    "text"
  ],
  "importName": "text",
  "forceImport": true,
  "notes": "text"
}

200

Success

{
  "status": {
    "importType": "text",
    "importSize": 1,
    "importName": "text",
    "importedMemories": 1,
    "importWarningsCount": 1,
    "importWarnings": [
      {
        "warningType": "text",
        "rowNumber": 1,
        "text": "text",
        "similarTexts": [
          {
            "text": "text",
            "similarityLevel": "text"
          }
        ]
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2025-06-07T15:19:19.973Z",
    "end": "2025-06-07T15:19:19.973Z",
    "eta": 1,
    "creationTimestamp": "2025-06-07T15:19:19.973Z",
    "lastChangeTimestamp": "2025-06-07T15:19:19.973Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:19:19.973Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Starts an Import process for a new Memori from a jsonl file.

post

Path parameters

strTokenstringRequired

The login token

Body

memoriNamestring | nullableOptional

The name of the memori that will be created during the import process.

memoriPasswordstring | 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

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

memoriZipAssetIdstring | nullableOptional

The ID of the uploaded asset containing the zip file to import.

rowsstring[] | nullableOptional

Rows of the file to be imported. Required. Except when importing an agent, in which case this field must be left empty.

importNamestring | nullableOptional

Optional name of this import.

forceImportbooleanOptional

Specifies if questions having a high similarity with already stored questions have to be imported. If true, all questions are imported without checking the similarity.

notesstring | nullableOptional

Additional notes about the import.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ImportMemori/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "memoriName": "text",
  "memoriPassword": "text",
  "privacyType": "text",
  "memoriZipAssetId": "text",
  "rows": [
    "text"
  ],
  "importName": "text",
  "forceImport": true,
  "notes": "text"
}

200

Success

{
  "status": {
    "importType": "text",
    "importSize": 1,
    "importName": "text",
    "importedMemories": 1,
    "importWarningsCount": 1,
    "importWarnings": [
      {
        "warningType": "text",
        "rowNumber": 1,
        "text": "text",
        "similarTexts": [
          {
            "text": "text",
            "similarityLevel": "text"
          }
        ]
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2025-06-07T15:19:19.973Z",
    "end": "2025-06-07T15:19:19.973Z",
    "eta": 1,
    "creationTimestamp": "2025-06-07T15:19:19.973Z",
    "lastChangeTimestamp": "2025-06-07T15:19:19.973Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:19:19.973Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Exports contents of a Memori object to a CSV file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications for an Export CSV request.

passwordstring | nullableOptional

Memori password, if its privacy model is set to Secret.

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "csvSpecs": {
    "newLine": "text",
    "hasHeaders": true,
    "headerNames": [
      "text"
    ],
    "questionColumnName": "text",
    "answerColumnName": "text",
    "contextVarsToMatchColumnName": "text",
    "contextVarsToSetColumnName": "text",
    "memoryTagsColumnName": "text",
    "csvSeparator": "text",
    "questionTitleVariantsSeparator": "text"
  },
  "password": "text"
}

200

Success

No content

Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

Specifications for an Export JSONL request.

passwordstring | nullableOptional

Memori password, if its privacy model is set to Secret.

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "jsonlSpecs": {
    "platform": "text",
    "includeInstructions": true,
    "createdOrChangedAfter": "2025-06-07T15:19:19.973Z"
  },
  "password": "text"
}

200

Success

No content

Exports functions, intents and intentSlots of a Memori object to a JSONL file

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

exportFunctionsbooleanOptional

If true, export functions.

exportIntentsbooleanOptional

If true, export intents.

exportIntentSlotsbooleanOptional

If true, export intent slots.

functionsIdsstring[] | nullableOptional

If specified only the functions with the given IDs will be exported.

intentsIdsstring[] | nullableOptional

If specified only the intents with the given IDs will be exported.

intentSlotsIdsstring[] | nullableOptional

If specified only the intent slots with the given IDs will be exported.

passwordstring | nullableOptional

Memori password, if its privacy model is set to Secret.

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "exportFunctions": true,
  "exportIntents": true,
  "exportIntentSlots": true,
  "functionsIds": [
    "text"
  ],
  "intentsIds": [
    "text"
  ],
  "intentSlotsIds": [
    "text"
  ],
  "password": "text"
}

200

Success

No content

Imports a dictionary to a Memori object.

post

Path parameters

strTokenstringRequired

strMemoriIDstringRequired

Body

Specifications for an Import Dictionary request.

rowsstring[] | nullableOptional

Rows of the file to be imported. Required. Except when importing an agent, in which case this field must be left empty.

importNamestring | nullableOptional

Optional name of this import.

forceImportbooleanOptional

Specifies if questions having a high similarity with already stored questions have to be imported. If true, all questions are imported without checking the similarity.

notesstring | nullableOptional

Additional notes about the import.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "rows": [
    "text"
  ],
  "importName": "text",
  "forceImport": true,
  "notes": "text"
}

200

Success

{
  "status": {
    "importType": "text",
    "importSize": 1,
    "importName": "text",
    "importedMemories": 1,
    "importWarningsCount": 1,
    "importWarnings": [
      {
        "warningType": "text",
        "rowNumber": 1,
        "text": "text",
        "similarTexts": [
          {
            "text": "text",
            "similarityLevel": "text"
          }
        ]
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2025-06-07T15:19:19.973Z",
    "end": "2025-06-07T15:19:19.973Z",
    "eta": 1,
    "creationTimestamp": "2025-06-07T15:19:19.973Z",
    "lastChangeTimestamp": "2025-06-07T15:19:19.973Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:19:19.973Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Exports the dictionary of a Memori object to a JSONL file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

passwordstring | nullableOptional

Memori password, if its privacy model is set to Secret.

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "dictionarySpecs": {
    "words": [
      "text"
    ]
  },
  "password": "text"
}

200

Success

No content

Exports the dictionary of a Memori object to a JSONL file.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

passwordstring | nullableOptional

Memori password, if its privacy model is set to Secret.

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /api/v2/ImportExport/ExportMemori/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

200

Success

No content