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. Engine

Intents

PreviousFunctionsNextLocalizationKeys

Lists all Intent objects.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

Responses
200
Success
application/json
get
GET /memori/v2/Intents/{strSessionID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "count": 1,
  "intents": [
    {
      "intentID": "text",
      "intentType": "text",
      "name": "text",
      "utterances": [
        {
          "utteranceID": "text",
          "text": "text",
          "creationTimestamp": "2025-06-07T19:44:26.791Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
          "lastChangeSessionID": "text"
        }
      ],
      "timeoutIntent": true,
      "webHook": "text",
      "validityMinutes": 1,
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Intent 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 Intent object to list

howManyinteger · int32Required

The number of the Intent objects to list

Responses
200
Success
application/json
get
GET /memori/v2/Intents/{strSessionID}/{from}/{howMany} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "count": 1,
  "intents": [
    {
      "intentID": "text",
      "intentType": "text",
      "name": "text",
      "utterances": [
        {
          "utteranceID": "text",
          "text": "text",
          "creationTimestamp": "2025-06-07T19:44:26.791Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
          "lastChangeSessionID": "text"
        }
      ],
      "timeoutIntent": true,
      "webHook": "text",
      "validityMinutes": 1,
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of an Intent object.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strIntentIDstringRequired

The Intent object ID

Responses
200
Success
application/json
get
GET /memori/v2/Intent/{strSessionID}/{strIntentID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "intent": {
    "intentID": "text",
    "intentType": "text",
    "name": "text",
    "utterances": [
      {
        "utteranceID": "text",
        "text": "text",
        "creationTimestamp": "2025-06-07T19:44:26.791Z",
        "creationSessionID": "text",
        "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
        "lastChangeSessionID": "text"
      }
    ],
    "timeoutIntent": true,
    "webHook": "text",
    "validityMinutes": 1,
    "creationTimestamp": "2025-06-07T19:44:26.791Z",
    "creationSessionID": "text",
    "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
    "lastChangeSessionID": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Intent object.

delete

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strIntentIDstringRequired

The Intent object ID

Responses
200
Success
application/json
delete
DELETE /memori/v2/Intent/{strSessionID}/{strIntentID} HTTP/1.1
Host: 
Accept: */*
200

Success

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

Lists all Intent Slot objects.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

Responses
200
Success
application/json
get
GET /memori/v2/IntentSlots/{strSessionID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "count": 1,
  "intentSlots": [
    {
      "intentSlotID": "text",
      "name": "text",
      "values": [
        "text"
      ],
      "webHook": "text",
      "validityMinutes": 1,
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Intent Slot 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 Intent Slot object to list

howManyinteger · int32Required

The number of the Intent Slot objects to list

Responses
200
Success
application/json
get
GET /memori/v2/IntentSlots/{strSessionID}/{from}/{howMany} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "count": 1,
  "intentSlots": [
    {
      "intentSlotID": "text",
      "name": "text",
      "values": [
        "text"
      ],
      "webHook": "text",
      "validityMinutes": 1,
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of an Intent Slot object.

get

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strSlotIDstringRequired

The Intent Slot object ID

Responses
200
Success
application/json
get
GET /memori/v2/IntentSlot/{strSessionID}/{strSlotID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "intentSlot": {
    "intentSlotID": "text",
    "name": "text",
    "values": [
      "text"
    ],
    "webHook": "text",
    "validityMinutes": 1,
    "creationTimestamp": "2025-06-07T19:44:26.791Z",
    "creationSessionID": "text",
    "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
    "lastChangeSessionID": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Intent Slot object.

delete

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

strSlotIDstringRequired

The Intent Slot object ID

Responses
200
Success
application/json
delete
DELETE /memori/v2/IntentSlot/{strSessionID}/{strSlotID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}
  • GETLists all Intent objects.
  • GETLists Intent objects with pagination.
  • GETGets the details of an Intent object.
  • DELETERemoves an existing Intent object.
  • PATCHUpdates an existing Intent object.
  • POSTAdds a new Intent object.
  • GETLists all Intent Slot objects.
  • GETLists Intent Slot objects with pagination.
  • GETGets the details of an Intent Slot object.
  • DELETERemoves an existing Intent Slot object.
  • PATCHUpdates an existing Intent Slot object.
  • POSTAdds a new Intent Slot object.

Updates an existing Intent object.

patch

This API requires a Giver session. Only non-null (present) fields are considered for update. Null or absent fields are left unaltered.

Path parameters
strSessionIDstringRequired

The session ID

strIntentIDstringRequired

The Intent object ID

Body

Specifications for an Update Intent request.

intentIDstring | nullableOptional

Intent object ID.

intentTypestring | nullableOptional

Function type, e.g. Internal or WebHook. Internal intents are a limited subset implemented internally, while WebHook intents perform an external HTTP POST call to the specified web hook, passing an IntentWebHookRequest and expecting an IntentWebHookResponse in response. Required during Add operations. Ignored during Update operations.

namestring | nullableOptional

Name of the Intent object. It is part of the IntentWebHookRequest request passed to the web hook. Required during Add operations.

timeoutIntentboolean | nullableOptional

If True this Intent may be executed to serve a Timeout event in R1 state. In this case the utterance is null. In case more than one Intent have this flag set, a random one is picked.

webHookstring | nullableOptional

HTTP URL of the web hook to be called when the intent is recognized. If the intent is of Internal type, it is ignored.

validityMinutesnumber · double | nullableOptional

Time to cache the intent response, expressed in minutes. May be fractional. A cached intent response is used only when the a subsequent intent request matches exactly the original request. See also RequestValidityMinutes in WebHookRequest.

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
patch
PATCH /memori/v2/Intent/{strSessionID}/{strIntentID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 467

{
  "intentID": "text",
  "intentType": "text",
  "name": "text",
  "utterances": [
    {
      "utteranceID": "text",
      "text": "text",
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "timeoutIntent": true,
  "webHook": "text",
  "validityMinutes": 1,
  "creationTimestamp": "2025-06-07T19:44:26.791Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
  "lastChangeSessionID": "text"
}
200

Success

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

Adds a new Intent object.

post

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

Body

Specifications for an Add Intent request.

intentIDstring | nullableOptional

Intent object ID.

intentTypestring | nullableOptional

Function type, e.g. Internal or WebHook. Internal intents are a limited subset implemented internally, while WebHook intents perform an external HTTP POST call to the specified web hook, passing an IntentWebHookRequest and expecting an IntentWebHookResponse in response. Required during Add operations. Ignored during Update operations.

namestring | nullableOptional

Name of the Intent object. It is part of the IntentWebHookRequest request passed to the web hook. Required during Add operations.

timeoutIntentboolean | nullableOptional

If True this Intent may be executed to serve a Timeout event in R1 state. In this case the utterance is null. In case more than one Intent have this flag set, a random one is picked.

webHookstring | nullableOptional

HTTP URL of the web hook to be called when the intent is recognized. If the intent is of Internal type, it is ignored.

validityMinutesnumber · double | nullableOptional

Time to cache the intent response, expressed in minutes. May be fractional. A cached intent response is used only when the a subsequent intent request matches exactly the original request. See also RequestValidityMinutes in WebHookRequest.

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
POST /memori/v2/Intent/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 467

{
  "intentID": "text",
  "intentType": "text",
  "name": "text",
  "utterances": [
    {
      "utteranceID": "text",
      "text": "text",
      "creationTimestamp": "2025-06-07T19:44:26.791Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
      "lastChangeSessionID": "text"
    }
  ],
  "timeoutIntent": true,
  "webHook": "text",
  "validityMinutes": 1,
  "creationTimestamp": "2025-06-07T19:44:26.791Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
  "lastChangeSessionID": "text"
}
200

Success

{
  "intentID": "text",
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Intent Slot object.

patch

This API requires a Giver session. Only non-null (present) fields are considered for update. Null or absent fields are left unaltered.

Path parameters
strSessionIDstringRequired

The session ID

strSlotIDstringRequired

The Intent Slot object ID

Body

Specifications for an Update Intent Slot request.

intentSlotIDstring | nullableOptional

Intent Slot object ID.

namestring | nullableOptional

Name of the Intent Slot object. It is part of the SlotWebHookRequest request passed to the web hook. Required during Add operations.

valuesstring[] | nullableOptional

List of possible values of the slot. A slot may be composed of fixed values in this property, dynamic values fetched from the web hook, or a combination of both. Each value is considered only once (duplicate values are ignored).

webHookstring | nullableOptional

HTTP URL of the web hook to be called when the slot values must be fetched. May be null if the slot is composed only of fixed values in the Values property. If specified, the web hook is called periodically with an HTTP POST call, passing a SlotWebHookRequest and expecting a SlotWebHookResponse in response. Periodicity is determined by the ValidityMinutes property, with a minimum of 0.5 (30 seconds).

validityMinutesnumber · double | nullableOptional

Time to cache the slot values, expressed in minutes. May be fractional. A cached slot response is used only when the a subsequent slot request matches exactly the original request. See also RequestValidityMinutes in WebHookRequest.

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
patch
PATCH /memori/v2/IntentSlot/{strSessionID}/{strSlotID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "intentSlotID": "text",
  "name": "text",
  "values": [
    "text"
  ],
  "webHook": "text",
  "validityMinutes": 1,
  "creationTimestamp": "2025-06-07T19:44:26.791Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
  "lastChangeSessionID": "text"
}
200

Success

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

Adds a new Intent Slot object.

post

This API requires a Giver session.

Path parameters
strSessionIDstringRequired

The session ID

Body

Specifications for an Add Intent Slot request.

intentSlotIDstring | nullableOptional

Intent Slot object ID.

namestring | nullableOptional

Name of the Intent Slot object. It is part of the SlotWebHookRequest request passed to the web hook. Required during Add operations.

valuesstring[] | nullableOptional

List of possible values of the slot. A slot may be composed of fixed values in this property, dynamic values fetched from the web hook, or a combination of both. Each value is considered only once (duplicate values are ignored).

webHookstring | nullableOptional

HTTP URL of the web hook to be called when the slot values must be fetched. May be null if the slot is composed only of fixed values in the Values property. If specified, the web hook is called periodically with an HTTP POST call, passing a SlotWebHookRequest and expecting a SlotWebHookResponse in response. Periodicity is determined by the ValidityMinutes property, with a minimum of 0.5 (30 seconds).

validityMinutesnumber · double | nullableOptional

Time to cache the slot values, expressed in minutes. May be fractional. A cached slot response is used only when the a subsequent slot request matches exactly the original request. See also RequestValidityMinutes in WebHookRequest.

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
POST /memori/v2/IntentSlot/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "intentSlotID": "text",
  "name": "text",
  "values": [
    "text"
  ],
  "webHook": "text",
  "validityMinutes": 1,
  "creationTimestamp": "2025-06-07T19:44:26.791Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T19:44:26.791Z",
  "lastChangeSessionID": "text"
}
200

Success

{
  "intentSlotID": "text",
  "requestID": 1,
  "requestDateTime": "2025-06-07T19:44:26.791Z",
  "resultCode": 1,
  "resultMessage": "text"
}