AIsuru Docs
AIsuru API
AIsuru API
  • Introduzione
  • Engine
    • ChatLogs
    • ContextVars
    • CorrelationPairs
    • CustomDictionary
    • Dialog
    • EventLogs
    • ExpertReferences
    • Functions
    • Intents
    • LocalizationKeys
    • Media
    • Memories
    • NLP
    • People
    • Search
    • Session
    • Stats
    • Topics
    • UnansweredQuestions
    • User
    • WebHooks
    • Models
  • Backend
    • ActionLog
    • Analysis
    • Asset
    • Badge
    • CompletionConfig
    • ConsumptionLog
    • ImportExport
    • Integration
    • Invitation
    • Memori
    • MemoriList
    • Notification
    • Process
    • Tenant
    • User
    • Models
Powered by GitBook
On this page
  1. Backend

Integration

PreviousImportExportNextInvitation

Gets a list of Integration objects for a specified Memori object.

get
Path parameters
strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Responses
200
Success
application/json
get
GET /api/v2/Integrations/{strToken}/{strMemoriID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T13:22:47.124Z",
      "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of all Integration objects.

get

Access to Integration objects not belonging to the current logged in user is granted only to administrative users.

Path parameters
strTokenstringRequired

The login token

Responses
200
Success
application/json
get
GET /api/v2/AllIntegrations/{strToken} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "integrations": [
    {
      "integrationID": "text",
      "memoriID": "text",
      "type": "text",
      "state": "text",
      "deviceEmails": [
        "text"
      ],
      "invocationText": "text",
      "jobID": "text",
      "customData": "text",
      "resources": [
        {
          "name": "text",
          "url": "text"
        }
      ],
      "publish": true,
      "creationTimestamp": "2025-06-07T13:22:47.124Z",
      "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of an Integration object of the currently logged in User.

get

Access to Integration objects not belonging to the current logged in user is granted only to administrative users.

Path parameters
strTokenstringRequired

The login token

strIntegrationIDstringRequired

The ID of the Integration object

Responses
200
Success
application/json
get
GET /api/v2/Integration/{strToken}/{strIntegrationID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "integration": {
    "integrationID": "text",
    "memoriID": "text",
    "type": "text",
    "state": "text",
    "deviceEmails": [
      "text"
    ],
    "invocationText": "text",
    "jobID": "text",
    "customData": "text",
    "resources": [
      {
        "name": "text",
        "url": "text"
      }
    ],
    "publish": true,
    "creationTimestamp": "2025-06-07T13:22:47.124Z",
    "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes an existing Integration object.

delete
Path parameters
strTokenstringRequired

The login token

strIntegrationIDstringRequired

The Integration object ID

Responses
200
Success
application/json
delete
DELETE /api/v2/Integration/{strToken}/{strIntegrationID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}
  • GETGets a list of Integration objects for a specified Memori object.
  • GETGets a list of all Integration objects.
  • GETGets the details of an Integration object of the currently logged in User.
  • DELETEDeletes an existing Integration object.
  • PATCHUpdates an existing Integration object.
  • POSTRegisters a new Integration object.

Updates an existing Integration object.

patch
Path parameters
strTokenstringRequired

The login token

strIntegrationIDstringRequired

The Integration object ID

Body

Specifications of an Integration object.

integrationIDstring | nullableOptional

Integration ID. Unique and assigned by the system. Returned during Registration and Get operations. Ignored in other cases.

memoriIDstring | nullableOptional

ID of the Memori object this Integration refers to. Required during Registration operations. Returned during Get operations. Ignored in other cases.

typestring | nullableOptional

Type of this integration (Google, Alexa, landing home page, etc.). Required during Registration operations. Returned during Get operations. Ignored in other cases. May be one of the following: GOOGLE: a Google Home integration ALEXA: an Amazon Alexa integration LANDING_EXPERIENCE: a public Memori home page and landing experience

statestring | nullableOptional

Current state of deployment this integration. Returned during Registration and Get operations. Ignored in other cases. May be one of the following: NEW PROCESSING DONE REMOVED ERROR WAITING_MANUAL_ACTION DRAFT NOT_VALIDATED PUBLISHED

deviceEmailsstring[] | nullableOptional

List of e-mails associated with on-device accounts. Used during Registration and Update operations for integration types GOOGLE and ALEXA. Returned during Get operations. Ignored in other cases.

invocationTextstring | nullableOptional

Text to be spoken to invoke the integration. May be used during Registration and Update operations for integration types GOOGLE and ALEXA. Returned during Get operations. Ignored in other cases.

jobIDstring | nullableOptional

ID of the deployment job of this integration. Returned during Registration and Get operations. Ignored in other cases.

customDatastring | nullableOptional

JSON structure containing the data specific for this type of integration. May be used during Registration and Update operations, depending on the integration type. Returned during Get operations. Ignored in other cases.

publishboolean | nullableOptional

If set to True, the integration will be published on the corresponding environment (e.g. on Amazon Alexa or Google Home) to the general public. If False the integration will remain available only for testing. Used during Update operations. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses
200
Success
application/json
patch
PATCH /api/v2/Integration/{strToken}/{strIntegrationID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "integrationID": "text",
  "memoriID": "text",
  "type": "text",
  "state": "text",
  "deviceEmails": [
    "text"
  ],
  "invocationText": "text",
  "jobID": "text",
  "customData": "text",
  "resources": [
    {
      "name": "text",
      "url": "text"
    }
  ],
  "publish": true,
  "creationTimestamp": "2025-06-07T13:22:47.124Z",
  "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
}
200

Success

{
  "integration": {
    "integrationID": "text",
    "memoriID": "text",
    "type": "text",
    "state": "text",
    "deviceEmails": [
      "text"
    ],
    "invocationText": "text",
    "jobID": "text",
    "customData": "text",
    "resources": [
      {
        "name": "text",
        "url": "text"
      }
    ],
    "publish": true,
    "creationTimestamp": "2025-06-07T13:22:47.124Z",
    "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Registers a new Integration object.

post
Path parameters
strTokenstringRequired

The login token

Body

Specifications of an Integration object.

integrationIDstring | nullableOptional

Integration ID. Unique and assigned by the system. Returned during Registration and Get operations. Ignored in other cases.

memoriIDstring | nullableOptional

ID of the Memori object this Integration refers to. Required during Registration operations. Returned during Get operations. Ignored in other cases.

typestring | nullableOptional

Type of this integration (Google, Alexa, landing home page, etc.). Required during Registration operations. Returned during Get operations. Ignored in other cases. May be one of the following: GOOGLE: a Google Home integration ALEXA: an Amazon Alexa integration LANDING_EXPERIENCE: a public Memori home page and landing experience

statestring | nullableOptional

Current state of deployment this integration. Returned during Registration and Get operations. Ignored in other cases. May be one of the following: NEW PROCESSING DONE REMOVED ERROR WAITING_MANUAL_ACTION DRAFT NOT_VALIDATED PUBLISHED

deviceEmailsstring[] | nullableOptional

List of e-mails associated with on-device accounts. Used during Registration and Update operations for integration types GOOGLE and ALEXA. Returned during Get operations. Ignored in other cases.

invocationTextstring | nullableOptional

Text to be spoken to invoke the integration. May be used during Registration and Update operations for integration types GOOGLE and ALEXA. Returned during Get operations. Ignored in other cases.

jobIDstring | nullableOptional

ID of the deployment job of this integration. Returned during Registration and Get operations. Ignored in other cases.

customDatastring | nullableOptional

JSON structure containing the data specific for this type of integration. May be used during Registration and Update operations, depending on the integration type. Returned during Get operations. Ignored in other cases.

publishboolean | nullableOptional

If set to True, the integration will be published on the corresponding environment (e.g. on Amazon Alexa or Google Home) to the general public. If False the integration will remain available only for testing. Used during Update operations. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses
200
Success
application/json
post
POST /api/v2/Integration/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "integrationID": "text",
  "memoriID": "text",
  "type": "text",
  "state": "text",
  "deviceEmails": [
    "text"
  ],
  "invocationText": "text",
  "jobID": "text",
  "customData": "text",
  "resources": [
    {
      "name": "text",
      "url": "text"
    }
  ],
  "publish": true,
  "creationTimestamp": "2025-06-07T13:22:47.124Z",
  "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
}
200

Success

{
  "integration": {
    "integrationID": "text",
    "memoriID": "text",
    "type": "text",
    "state": "text",
    "deviceEmails": [
      "text"
    ],
    "invocationText": "text",
    "jobID": "text",
    "customData": "text",
    "resources": [
      {
        "name": "text",
        "url": "text"
      }
    ],
    "publish": true,
    "creationTimestamp": "2025-06-07T13:22:47.124Z",
    "lastChangeTimestamp": "2025-06-07T13:22:47.124Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T13:22:47.124Z",
  "resultCode": 1,
  "resultMessage": "text"
}