Sermas Events 1.0 documentation

Sermas Events 1.0

application/json

Sermas Events

Servers

mqtt://prod.sermas.spindoxlabs.it/mqttmqttsermas-broker

Operations

PUB app/:appId/platform/token
Publish an update when a new access token is requested event

Operation IDtokenRequested
- #platform
Accepts the following message:
PlatformTokenAsyncApiService#tokenRequested
object
uid: PlatformTokenDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SUB app/:appId/platform/token
Subscribe to an update when a new access token is requested event

Operation IDonTokenRequested
- #platform
Accepts the following message:
PlatformTokenAsyncApiService#tokenRequested
object
uid: PlatformTokenDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
PUB app/:appId/platform/app/changed/:appId
Publish an app changed event

Operation IDappChanged
- #platform
Accepts the following message:
PlatformAppAsyncApiService#appChanged
object
uid: PlatformAppChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: PlatformAppDto
appId
required
string
public
boolean
name
required
string
description
required
string
ownerId
required
string
Owner of the application

required
array<object>
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
required
object
uid: RepositoryConfigDto
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
required
array<object>
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
createdAt
string
format: date-time
updatedAt
string
format: date-time
array<object>
Application tools offered by the application

name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

array<object>
Structured tasks offered by the application

taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
allOf
List of RAG documents or urls to import

object
uid: RagDocumentsDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "public": true, "name": "string", "description": "string", "ownerId": "string", "modules": [ { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string", "appId": "string" } ], "repository": { "avatars": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "modelType": "readyplayerme", "gender": "M", "camera": { "position": { "x": 0, "y": 0, "z": 0 }, "rotation": { "x": 0, "y": 0, "z": 0 } }, "cameraMobile": { "position": { "x": 0, "y": 0, "z": 0 }, "rotation": { "x": 0, "y": 0, "z": 0 } }, "prompt": "string", "tts": { "provider": "string", "model": "string" } } ], "backgrounds": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": { "credits": "string" } } ], "robots": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "videoUrl": "string", "map": { "imageUrl": "string", "width": 0, "height": 0, "originOffsetX": 0, "originOffsetY": 0 } } ], "documents": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {} } ], "animations": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {} } ] }, "clients": [ { "appId": "string", "name": "string", "clientId": "string", "secret": "string", "permissions": [ "string" ] } ], "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "tools": [ { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } ], "tasks": [ { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } } ], "rag": {} } }

This example has been generated automatically.
SUB app/:appId/platform/app/changed/:appId
Subscribe to an app changed event

Operation IDonAppChanged
- #platform
Accepts the following message:
PlatformAppAsyncApiService#appChanged
object
uid: PlatformAppChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: PlatformAppDto
appId
required
string
public
boolean
name
required
string
description
required
string
ownerId
required
string
Owner of the application

required
array<object>
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
required
object
uid: RepositoryConfigDto
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
required
array<object>
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
createdAt
string
format: date-time
updatedAt
string
format: date-time
array<object>
Application tools offered by the application

name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

array<object>
Structured tasks offered by the application

taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
allOf
List of RAG documents or urls to import

object
uid: RagDocumentsDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "public": true, "name": "string", "description": "string", "ownerId": "string", "modules": [ { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string", "appId": "string" } ], "repository": { "avatars": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "modelType": "readyplayerme", "gender": "M", "camera": { "position": { "x": 0, "y": 0, "z": 0 }, "rotation": { "x": 0, "y": 0, "z": 0 } }, "cameraMobile": { "position": { "x": 0, "y": 0, "z": 0 }, "rotation": { "x": 0, "y": 0, "z": 0 } }, "prompt": "string", "tts": { "provider": "string", "model": "string" } } ], "backgrounds": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": { "credits": "string" } } ], "robots": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "videoUrl": "string", "map": { "imageUrl": "string", "width": 0, "height": 0, "originOffsetX": 0, "originOffsetY": 0 } } ], "documents": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {} } ], "animations": [ { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {} } ] }, "clients": [ { "appId": "string", "name": "string", "clientId": "string", "secret": "string", "permissions": [ "string" ] } ], "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "tools": [ { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } ], "tasks": [ { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } } ], "rag": {} } }

This example has been generated automatically.
PUB app/:appId/platform/client/changed/:clientId
Publish a client app changed event

Operation IDclientChanged
- #platform
Accepts the following message:
PlatformAppAsyncApiService#clientChanged
object
uid: PlatformAppClientChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppClientDto
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "name": "string", "clientId": "string", "secret": "string", "permissions": [ "string" ] } }

This example has been generated automatically.
SUB app/:appId/platform/client/changed/:clientId
Subscribe to a client app changed event

Operation IDonClientChanged
- #platform
Accepts the following message:
PlatformAppAsyncApiService#clientChanged
object
uid: PlatformAppClientChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppClientDto
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "name": "string", "clientId": "string", "secret": "string", "permissions": [ "string" ] } }

This example has been generated automatically.
PUB app/:appId/platform/module
Publish an app module change event

Operation IDappModuleChanged
- #platform
Accepts the following message:
PlatformAppModuleAsyncApiService#appModuleChanged
object
uid: PlatformAppModuleConfigEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string", "appId": "string" } }

This example has been generated automatically.
SUB app/:appId/platform/module
Subscribe to an app module change event

Operation IDonAppModuleChanged
- #platform
Accepts the following message:
PlatformAppModuleAsyncApiService#appModuleChanged
object
uid: PlatformAppModuleConfigEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string", "appId": "string" } }

This example has been generated automatically.
PUB app/:appId/auth/update
Subscribe for receving event when user data are updated

Operation IDuserUpdate
- #auth
Accepts the following message:
AuthAsyncApiService#userUpdate
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
SUB app/:appId/auth/update
Subscribe for receving event when user data are updated

Operation IDonUserUpdate
- #auth
Accepts the following message:
AuthAsyncApiService#userUpdate
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
PUB app/:appId/auth/create
Subscribe for receving event when a new user join the the system

Operation IDuserRegistration
- #auth
Accepts the following message:
AuthAsyncApiService#userRegistration
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
SUB app/:appId/auth/create
Subscribe for receving event when a new user join the the system

Operation IDonUserRegistration
- #auth
Accepts the following message:
AuthAsyncApiService#userRegistration
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
PUB app/:appId/auth/login
Subscribe for receving event when a user is logged in

Operation IDuserLogin
- #auth
Accepts the following message:
AuthAsyncApiService#userLogin
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
SUB app/:appId/auth/login
Subscribe for receving event when a user is logged in

Operation IDonUserLogin
- #auth
Accepts the following message:
AuthAsyncApiService#userLogin
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "enabled": true }

This example has been generated automatically.
PUB system/platform/module/changed/:moduleId
Publish a platform module change event

Operation IDmoduleChanged
- #module
Accepts the following message:
PlatformModuleAsyncApiService#moduleChanged
object
uid: ModuleConfigEventDto
required
object
Additional properties are allowed.
ts
required
string
format: date-time
required
object
uid: PlatformModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "operation": {}, "ts": "2019-08-24T14:15:22Z", "record": { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string" } }

This example has been generated automatically.
SUB system/platform/module/changed/:moduleId
Subscribe to a platform module change event

Operation IDonModuleChanged
- #module
Accepts the following message:
PlatformModuleAsyncApiService#moduleChanged
object
uid: ModuleConfigEventDto
required
object
Additional properties are allowed.
ts
required
string
format: date-time
required
object
uid: PlatformModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "operation": {}, "ts": "2019-08-24T14:15:22Z", "record": { "moduleId": "string", "status": "string", "name": "string", "description": "string", "supports": [ "string" ], "config": { "url": "string", "openapiSpec": "string", "asyncapiSpec": "string", "resources": [ { "resource": "string", "scope": "string", "context": [ "string" ], "name": "string", "description": "string", "moduleId": "string", "operationId": "string", "emitEvent": true } ] }, "secret": "string" } }

This example has been generated automatically.
PUB app/:appId/detection/user
Publish an user detection event

Operation IDuserDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#userDetected
object
uid: UserDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

cameraId
required
string
source
required
string
required
array<object>
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "cameraId": "string", "source": "string", "detections": [ { "skeleton": [ "string" ], "face": { "x": 0, "y": 0, "w": 0, "h": 0 }, "faceMask": [ "string" ], "fullBody": { "x": 0, "y": 0, "w": 0, "h": 0 }, "user": [ { "probability": 0, "value": "string" } ], "position": { "x": 0, "y": 0, "z": 0 } } ] }

This example has been generated automatically.
SUB app/:appId/detection/user
Subscribe to an user detection event

Operation IDonUserDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#userDetected
object
uid: UserDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

cameraId
required
string
source
required
string
required
array<object>
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "cameraId": "string", "source": "string", "detections": [ { "skeleton": [ "string" ], "face": { "x": 0, "y": 0, "w": 0, "h": 0 }, "faceMask": [ "string" ], "fullBody": { "x": 0, "y": 0, "w": 0, "h": 0 }, "user": [ { "probability": 0, "value": "string" } ], "position": { "x": 0, "y": 0, "z": 0 } } ] }

This example has been generated automatically.
PUB app/:appId/detection/interaction
Publish an user interaction intention event

Operation IDinteractionIntention
- #detection
Accepts the following message:
DetectionAsyncApiService#interactionIntention
object
uid: UserInteractionIntentionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

moduleId
required
string
Module generating the event

source
required
string
probability
required
number
interactionType
required
string
Allowed values:
"start"
"stop"
sessionId
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "moduleId": "string", "source": "string", "probability": 0, "interactionType": "start", "sessionId": "string" }

This example has been generated automatically.
SUB app/:appId/detection/interaction
Subscribe to an user interaction intention event

Operation IDonInteractionIntention
- #detection
Accepts the following message:
DetectionAsyncApiService#interactionIntention
object
uid: UserInteractionIntentionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

moduleId
required
string
Module generating the event

source
required
string
probability
required
number
interactionType
required
string
Allowed values:
"start"
"stop"
sessionId
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "moduleId": "string", "source": "string", "probability": 0, "interactionType": "start", "sessionId": "string" }

This example has been generated automatically.
PUB app/:appId/detection/characterization
Publish an user emotion event

Operation IDuserCharacterization
- #detection
Accepts the following message:
DetectionAsyncApiService#userCharacterization
object
uid: UserCharacterizationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
required
object
uid: UserEmotionValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserAgeValue
probability
required
number
value
required
number
Additional properties are allowed.
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "source": "string", "detections": [ { "emotion": { "probability": 0, "value": "string" }, "age": { "probability": 0, "value": 0 }, "user": [ { "probability": 0, "value": "string" } ] } ], "sessionId": "string" }

This example has been generated automatically.
SUB app/:appId/detection/characterization
Subscribe to an user emotion event

Operation IDonUserCharacterization
- #detection
Accepts the following message:
DetectionAsyncApiService#userCharacterization
object
uid: UserCharacterizationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
required
object
uid: UserEmotionValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserAgeValue
probability
required
number
value
required
number
Additional properties are allowed.
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "source": "string", "detections": [ { "emotion": { "probability": 0, "value": "string" }, "age": { "probability": 0, "value": 0 }, "user": [ { "probability": 0, "value": "string" } ] } ], "sessionId": "string" }

This example has been generated automatically.
PUB app/:appId/detection/audio
Publish an audio classification event

Operation IDaudioClassification
- #detection
Accepts the following message:
DetectionAsyncApiService#audioClassification
object
uid: AudioClassificationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "source": "string", "detections": [ { "probability": 0, "value": "string" } ], "sessionId": "string" }

This example has been generated automatically.
SUB app/:appId/detection/audio
Subscribe to an audio classification event

Operation IDonAudioClassification
- #detection
Accepts the following message:
DetectionAsyncApiService#audioClassification
object
uid: AudioClassificationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "source": "string", "detections": [ { "probability": 0, "value": "string" } ], "sessionId": "string" }

This example has been generated automatically.
PUB app/:appId/detection/object
Publish a object detection event

Operation IDobjectDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#objectDetected
object
uid: ObjectDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<object>
probability
required
number
value
required
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "detections": [ { "probability": 0, "value": "string", "bbox": { "x": 0, "y": 0, "w": 0, "h": 0 } } ] }

This example has been generated automatically.
SUB app/:appId/detection/object
Subscribe to a object detection event

Operation IDonObjectDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#objectDetected
object
uid: ObjectDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<object>
probability
required
number
value
required
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "detections": [ { "probability": 0, "value": "string", "bbox": { "x": 0, "y": 0, "w": 0, "h": 0 } } ] }

This example has been generated automatically.
PUB app/:appId/detection/qr_code
Publish a QR Code detection event

Operation IDqrCodeDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#qrCodeDetected
object
uid: QRCodeEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

version
required
string
payload
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "version": "string", "payload": "string", "sessionId": "string" }

This example has been generated automatically.
SUB app/:appId/detection/qr_code
Subscribe to a QR Code detection event

Operation IDonQrCodeDetected
- #detection
Accepts the following message:
DetectionAsyncApiService#qrCodeDetected
object
uid: QRCodeEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

version
required
string
payload
required
string
sessionId
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "version": "string", "payload": "string", "sessionId": "string" }

This example has been generated automatically.
PUB app/:appId/detection/noise
Publish a noise detection event

Operation IDnoise
- #detection
Accepts the following message:
DetectionAsyncApiService#noise
object
uid: NoiseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

noiseType
required
string
level
required
string
required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "noiseType": "string", "level": "string", "speakerId": [ "string" ] }

This example has been generated automatically.
SUB app/:appId/detection/noise
Subscribe to a noise detection event

Operation IDonNoise
- #detection
Accepts the following message:
DetectionAsyncApiService#noise
object
uid: NoiseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

noiseType
required
string
level
required
string
required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "noiseType": "string", "level": "string", "speakerId": [ "string" ] }

This example has been generated automatically.
PUB app/:appId/dialogue/messages/:sessionId
Publish text of the speech exchanges

Operation IDdialogueMessages
- #dialogue
Accepts the following message:
DialogueAsyncApiService#dialogueMessages
object
uid: DialogueMessageDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
User session identifier

actor
string
uid: DialogueActor
Actor providing the text, can be user or agent

Allowed values:
"user"
"agent"
text
required
string
Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.

gender
string
Assistant gender (M or F)

language
string
Text language

emotion
string
User emotion, if available

allOf
LLM engine to use

object
uid: LLMSettingsDto
Additional properties are allowed.
avatar
string
The avatar id used for interaction

messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

ttsEnabled
boolean
Toggle TTS rendering for this message

Default value:true
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "actor": "user", "text": "string", "gender": "string", "language": "string", "emotion": "string", "llm": {}, "avatar": "string", "messageId": "string", "chunkId": "string", "ttsEnabled": true }

This example has been generated automatically.
SUB app/:appId/dialogue/messages/:sessionId
Subscribe to text of the speech exchanges

Operation IDonDialogueMessages
- #dialogue
Accepts the following message:
DialogueAsyncApiService#dialogueMessages
object
uid: DialogueMessageDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
User session identifier

actor
string
uid: DialogueActor
Actor providing the text, can be user or agent

Allowed values:
"user"
"agent"
text
required
string
Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.

gender
string
Assistant gender (M or F)

language
string
Text language

emotion
string
User emotion, if available

allOf
LLM engine to use

object
uid: LLMSettingsDto
Additional properties are allowed.
avatar
string
The avatar id used for interaction

messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

ttsEnabled
boolean
Toggle TTS rendering for this message

Default value:true
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "actor": "user", "text": "string", "gender": "string", "language": "string", "emotion": "string", "llm": {}, "avatar": "string", "messageId": "string", "chunkId": "string", "ttsEnabled": true }

This example has been generated automatically.
PUB app/:appId/dialogue/speech/:sessionId/:chunkId
Publish agent message

Operation IDagentSpeech
- #dialogue
Accepts the following message:
DialogueAsyncApiService#agentSpeech
object
uid: Buffer
Additional properties are allowed.
Examples
{}

This example has been generated automatically.
SUB app/:appId/dialogue/speech/:sessionId/:chunkId
Subscribe to agent message

Operation IDonAgentSpeech
- #dialogue
Accepts the following message:
DialogueAsyncApiService#agentSpeech
object
uid: Buffer
Additional properties are allowed.
Examples
{}

This example has been generated automatically.
PUB app/:appId/dialogue/stop/:sessionId
Publish a stop speaking command for the agent

Operation IDagentStopSpeech
- #dialogue
Accepts the following message:
DialogueAsyncApiService#agentStopSpeech
object
uid: SermasSessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string" }

This example has been generated automatically.
SUB app/:appId/dialogue/stop/:sessionId
Subscribe to a stop speaking command for the agent

Operation IDonAgentStopSpeech
- #dialogue
Accepts the following message:
DialogueAsyncApiService#agentStopSpeech
object
uid: SermasSessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string" }

This example has been generated automatically.
PUB app/:appId/dialogue/task/changed/:taskId
Publish a task change event

Operation IDtaskChanged
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#taskChanged
object
uid: DialogueTaskChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } } }

This example has been generated automatically.
SUB app/:appId/dialogue/task/changed/:taskId
Subscribe to a task change event

Operation IDonTaskChanged
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#taskChanged
object
uid: DialogueTaskChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } } }

This example has been generated automatically.
PUB app/:appId/dialogue/task/progress/:taskId
Publish a task progress event

Operation IDtaskProgress
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#taskProgress
object
uid: DialogueTaskProgressDto
type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
allOf
Task

object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
required
allOf
Task field

object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "started", "task": { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } }, "record": { "recordId": "string", "taskId": "string", "appId": "string", "sessionId": "string", "status": "started", "values": {}, "updated": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
SUB app/:appId/dialogue/task/progress/:taskId
Subscribe to a task progress event

Operation IDonTaskProgress
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#taskProgress
object
uid: DialogueTaskProgressDto
type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
allOf
Task

object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
required
allOf
Task field

object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "started", "task": { "taskId": "string", "appId": "string", "sessionId": "string", "name": "string", "label": "string", "description": "string", "intents": [ { "name": "string", "description": "string" } ], "events": [ { "type": "started", "message": "string", "condition": "string", "trigger": [ { "name": "string", "values": {}, "condition": "string" } ] } ], "fields": [ { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } ], "options": { "triggerOnce": true, "removeRecord": true, "enableTool": true, "toolOptions": { "triggerOnce": true, "exclusive": true }, "repositoryId": "string", "list": true, "oncePerSession": true, "matchOrRemove": true } }, "record": { "recordId": "string", "taskId": "string", "appId": "string", "sessionId": "string", "status": "started", "values": {}, "updated": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
PUB app/:appId/dialogue/task/record/:taskId
Publish a task record update event

Operation IDrecordChanged
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#recordChanged
object
uid: DialogueTaskRecordChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "recordId": "string", "taskId": "string", "appId": "string", "sessionId": "string", "status": "started", "values": {}, "updated": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
SUB app/:appId/dialogue/task/record/:taskId
Subscribe to a task record update event

Operation IDonRecordChanged
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#recordChanged
object
uid: DialogueTaskRecordChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "recordId": "string", "taskId": "string", "appId": "string", "sessionId": "string", "status": "started", "values": {}, "updated": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
PUB app/:appId/dialogue/task/handler
Publish a task field handler event

Operation IDfieldHandler
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#fieldHandler
object
uid: DialogueTaskRecordHandlerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

taskId
required
string
Task Id

recordId
required
string
Record Id

required
allOf
Field reference

object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "taskId": "string", "recordId": "string", "field": { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } }

This example has been generated automatically.
SUB app/:appId/dialogue/task/handler
Subscribe to a task field handler event

Operation IDonFieldHandler
- #dialogue
Accepts the following message:
DialogueTasksAsyncApiService#fieldHandler
object
uid: DialogueTaskRecordHandlerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

taskId
required
string
Task Id

recordId
required
string
Record Id

required
allOf
Field reference

object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "taskId": "string", "recordId": "string", "field": { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } }

This example has been generated automatically.
PUB app/:appId/dialogue/tool/:name
Publish the tool that triggered from the user prompt

Operation IDtoolTriggered
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolTriggered
object
uid: DialogueToolTriggeredEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

name
required
string
required
object
uid: AppToolsDTO
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "name": "string", "tool": { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } }

This example has been generated automatically.
SUB app/:appId/dialogue/tool/:name
Subscribe to the tool that triggered from the user prompt

Operation IDonToolTriggered
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolTriggered
object
uid: DialogueToolTriggeredEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

name
required
string
required
object
uid: AppToolsDTO
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "name": "string", "tool": { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } }

This example has been generated automatically.
PUB app/:appId/dialogue/tool/changed/:repositoryId
Publish the updated tools list for a session

Operation IDtoolChanged
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolChanged
object
uid: DialogueToolsRepositoryChanged
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueToolsRepositoryRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

repositoryId
string
Tool repository ID

allOf
Tool repository options

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
array<array<any>>
Tools list

array<any>
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "repositoryId": "string", "options": { "triggerOnce": true, "exclusive": true }, "tools": [ [] ] } }

This example has been generated automatically.
SUB app/:appId/dialogue/tool/changed/:repositoryId
Subscribe to the updated tools list for a session

Operation IDonToolChanged
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolChanged
object
uid: DialogueToolsRepositoryChanged
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueToolsRepositoryRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

repositoryId
string
Tool repository ID

allOf
Tool repository options

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
array<array<any>>
Tools list

array<any>
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "repositoryId": "string", "options": { "triggerOnce": true, "exclusive": true }, "tools": [ [] ] } }

This example has been generated automatically.
PUB app/:appId/dialogue/tool/not-matching
Indicate non of the available tools matches the user message

Operation IDtoolNotMatching
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolNotMatching
object
uid: DialogueToolNotMatchingEventDto
appId
required
string
sessionId
required
string
required
array<object>
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

required
array<string>
Items:
string
taskId
string
object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "sessionId": "string", "tools": [ { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } ], "repositories": [ "string" ], "taskId": "string", "currentField": { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } }

This example has been generated automatically.
SUB app/:appId/dialogue/tool/not-matching
Indicate non of the available tools matches the user message

Operation IDonToolNotMatching
- #dialogue
Accepts the following message:
DialogueToolsAsyncApiService#toolNotMatching
object
uid: DialogueToolNotMatchingEventDto
appId
required
string
sessionId
required
string
required
array<object>
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

required
array<string>
Items:
string
taskId
string
object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "sessionId": "string", "tools": [ { "name": "string", "description": "string", "schema": [ { "parameter": "string", "type": "string", "description": "string", "ignore": true, "value": "string" } ], "request": { "auth": "string", "basic": { "username": "string", "password": "string" }, "bearer": { "clientType": "string", "clientId": "string", "clientSecret": "string", "username": "string", "password": "string", "audience": "string", "tokenUrl": "string", "refreshUrl": "string" }, "moduleId": "string", "url": "string", "headers": {} }, "emitter": "string", "returnDirect": true, "skipResponse": true, "url": "string" } ], "repositories": [ "string" ], "taskId": "string", "currentField": { "name": "string", "label": "string", "order": 0, "type": "text", "required": false, "validation": "string", "condition": "string", "prompt": "string", "handler": "string", "multiple": true, "options": [ { "value": "string", "label": "string", "description": "string" } ] } }

This example has been generated automatically.
PUB app/:appId/session/interaction/user
Publish a status update for a user interaction

Operation IDuserInteraction
- #session
Accepts the following message:
SessionAsyncApiService#userInteraction
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "agentId": "string", "user": [ "string" ], "modifiedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z", "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "properties": { "repositoryId": "string" } }

This example has been generated automatically.
SUB app/:appId/session/interaction/user
Subscribe to a status update for a user interaction

Operation IDonUserInteraction
- #session
Accepts the following message:
SessionAsyncApiService#userInteraction
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "agentId": "string", "user": [ "string" ], "modifiedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z", "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "properties": { "repositoryId": "string" } }

This example has been generated automatically.
PUB app/:appId/session/session/changed/:sessionId
Publish an update for a session record update

Operation IDsessionChanged
- #session
Accepts the following message:
SessionAsyncApiService#sessionChanged
object
uid: SessionChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "agentId": "string", "user": [ "string" ], "modifiedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z", "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "properties": { "repositoryId": "string" } } }

This example has been generated automatically.
SUB app/:appId/session/session/changed/:sessionId
Subscribe to an update for a session record update

Operation IDonSessionChanged
- #session
Accepts the following message:
SessionAsyncApiService#sessionChanged
object
uid: SessionChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "agentId": "string", "user": [ "string" ], "modifiedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z", "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} }, "properties": { "repositoryId": "string" } } }

This example has been generated automatically.
PUB app/:appId/session/support
Receive status updates for a support request

Operation IDsupport
- #session
Accepts the following message:
SessionSupportAsyncApiService#support
object
uid: SessionSupportEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

supportId
required
string
status
required
string
feedback
required
string
code
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "supportId": "string", "status": "string", "feedback": "string", "code": "string" }

This example has been generated automatically.
SUB app/:appId/session/support
Receive status updates for a support request

Operation IDonSupport
- #session
Accepts the following message:
SessionSupportAsyncApiService#support
object
uid: SessionSupportEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

supportId
required
string
status
required
string
feedback
required
string
code
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "supportId": "string", "status": "string", "feedback": "string", "code": "string" }

This example has been generated automatically.
PUB app/:appId/session/storage/:storageId
Receive updates on storage changes

Operation IDstorageUpdated
- #session
Accepts the following message:
SessionStorageAsyncApiService#storageUpdated
object
uid: SessionStorageEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionStorageRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

storageId
string
sessionId
string
required
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "storageId": "string", "sessionId": "string", "data": {} } }

This example has been generated automatically.
SUB app/:appId/session/storage/:storageId
Receive updates on storage changes

Operation IDonStorageUpdated
- #session
Accepts the following message:
SessionStorageAsyncApiService#storageUpdated
object
uid: SessionStorageEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionStorageRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

storageId
string
sessionId
string
required
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "storageId": "string", "sessionId": "string", "data": {} } }

This example has been generated automatically.
PUB app/:appId/session/interaction/agent
Publish a status update for agent interaction

Operation IDagentInteraction
- #session
Accepts the following message:
SessionAgentAsyncApiService#agentInteraction
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "agentId": "string", "status": "unavailable", "modules": [ "string" ] }

This example has been generated automatically.
SUB app/:appId/session/interaction/agent
Subscribe to a status update for agent interaction

Operation IDonAgentInteraction
- #session
Accepts the following message:
SessionAgentAsyncApiService#agentInteraction
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "agentId": "string", "status": "unavailable", "modules": [ "string" ] }

This example has been generated automatically.
PUB app/:appId/session/agent/changed/:agentId
Publish updates for agent record changes

Operation IDagentChanged
- #session
Accepts the following message:
SessionAgentAsyncApiService#agentChanged
object
uid: AgentChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
moduleId
required
string
required
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "moduleId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "agentId": "string", "status": "unavailable", "modules": [ "string" ] }, "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} } }

This example has been generated automatically.
SUB app/:appId/session/agent/changed/:agentId
Subscribe to updates for agent record changes

Operation IDonAgentChanged
- #session
Accepts the following message:
SessionAgentAsyncApiService#agentChanged
object
uid: AgentChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
moduleId
required
string
required
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "moduleId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "agentId": "string", "status": "unavailable", "modules": [ "string" ] }, "settings": { "skipToolResponse": true, "ttsEnabled": true, "login": true, "chatModeEnabled": true, "avatar": "string", "language": "string", "llm": {}, "background": "string", "prompt": { "text": "string" }, "skipWelcomeMessage": true, "interactionStart": "on-load", "theme": {} } }

This example has been generated automatically.
PUB app/:appId/ui/status
Publish a status update for a UI asset

Operation IDassetChanged
- #ui
Accepts the following message:
UIAsyncApiService#assetChanged
object
uid: UIAssetChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: UIAssetDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
filename
string
appId
required
string
userId
string
ts
string
format: date-time
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "filename": "string", "appId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
SUB app/:appId/ui/status
Subscribe to a status update for a UI asset

Operation IDonAssetChanged
- #ui
Accepts the following message:
UIAsyncApiService#assetChanged
object
uid: UIAssetChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: UIAssetDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
filename
string
appId
required
string
userId
string
ts
string
format: date-time
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "id": "string", "type": "avatars", "name": "string", "path": "string", "metadata": {}, "filename": "string", "appId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z" } }

This example has been generated automatically.
PUB app/:appId/ui/content
Publish an event with content to show

Operation IDcontent
- #ui
Accepts the following message:
UIAsyncApiService#content
object
uid: UIContentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

contentType
required
string
uid: SupportedContentTypes
Allowed values:
"video"
"image"
"pdf"
"webpage"
"object"
"text"
"email"
"html"
"link"
"dialogue-message"
"navigation"
"buttons"
"quiz"
"clear-screen"
"qrcode-scanner"
required
object
Additional properties are allowed.
description
string
Provide a description for the content

allOf
Provides metadata for the content

object
uid: UIContentMetadataDto
repositoryId
string
Reference to a tool repository ID

Additional properties are allowed.
object
Additional properties are allowed.
allOf
Provides configuration options for the content

object
uid: UIContentOptionsDto
clearScreen
boolean
Clear the UI screen

ttsEnabled
boolean
Enable agent reading the content (text to speech)

stopSpeech
boolean
Stop the agent speech

language
string
Define the language of the content, it will be translated based on the language selected by the user.

Additional properties are allowed.
object
Additional properties are allowed.
messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "contentType": "video", "content": {}, "description": "string", "metadata": { "repositoryId": "string" }, "options": { "clearScreen": true, "ttsEnabled": true, "stopSpeech": true, "language": "string" }, "messageId": "string", "chunkId": "string" }

This example has been generated automatically.
SUB app/:appId/ui/content
Subscribe to an event with content to show

Operation IDonContent
- #ui
Accepts the following message:
UIAsyncApiService#content
object
uid: UIContentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

contentType
required
string
uid: SupportedContentTypes
Allowed values:
"video"
"image"
"pdf"
"webpage"
"object"
"text"
"email"
"html"
"link"
"dialogue-message"
"navigation"
"buttons"
"quiz"
"clear-screen"
"qrcode-scanner"
required
object
Additional properties are allowed.
description
string
Provide a description for the content

allOf
Provides metadata for the content

object
uid: UIContentMetadataDto
repositoryId
string
Reference to a tool repository ID

Additional properties are allowed.
object
Additional properties are allowed.
allOf
Provides configuration options for the content

object
uid: UIContentOptionsDto
clearScreen
boolean
Clear the UI screen

ttsEnabled
boolean
Enable agent reading the content (text to speech)

stopSpeech
boolean
Stop the agent speech

language
string
Define the language of the content, it will be translated based on the language selected by the user.

Additional properties are allowed.
object
Additional properties are allowed.
messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "contentType": "video", "content": {}, "description": "string", "metadata": { "repositoryId": "string" }, "options": { "clearScreen": true, "ttsEnabled": true, "stopSpeech": true, "language": "string" }, "messageId": "string", "chunkId": "string" }

This example has been generated automatically.
PUB app/:appId/ui/interaction/:moduleId
Publish an user interaction event

Operation IDinteraction
- #ui
Accepts the following message:
UIAsyncApiService#interaction
object
uid: UIInteractionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

moduleId
required
string
required
object
uid: UIInteractionDTO
required
object
Additional properties are allowed.
element
required
string
value
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "moduleId": "string", "interaction": { "context": {}, "element": "string", "value": "string" } }

This example has been generated automatically.
SUB app/:appId/ui/interaction/:moduleId
Subscribe to an user interaction event

Operation IDonInteraction
- #ui
Accepts the following message:
UIAsyncApiService#interaction
object
uid: UIInteractionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

moduleId
required
string
required
object
uid: UIInteractionDTO
required
object
Additional properties are allowed.
element
required
string
value
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "sessionId": "string", "moduleId": "string", "interaction": { "context": {}, "element": "string", "value": "string" } }

This example has been generated automatically.
PUB app/:appId/platform/monitoring
Publish an update for a monitoring record update

Operation IDrecord
- #platform
Accepts the following message:
MonitoringAsyncApiService#record
object
uid: MonitoringRecordDto
appId
required
string
sessionId
required
string
type
string
uid: LogType
Allowed values:
"characterization"
"stt"
"tts"
"interaction"
"session"
"document"
"chat"
"task"
"performance"
"kpi"
"error"
label
required
string
ts
required
string
format: date-time
Additional properties are allowed.
Examples
{ "appId": "string", "sessionId": "string", "type": "characterization", "label": "string", "ts": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SUB app/:appId/platform/monitoring
Subscribe to an update for a monitoring record update

Operation IDonRecord
- #platform
Accepts the following message:
MonitoringAsyncApiService#record
object
uid: MonitoringRecordDto
appId
required
string
sessionId
required
string
type
string
uid: LogType
Allowed values:
"characterization"
"stt"
"tts"
"interaction"
"session"
"document"
"chat"
"task"
"performance"
"kpi"
"error"
label
required
string
ts
required
string
format: date-time
Additional properties are allowed.
Examples
{ "appId": "string", "sessionId": "string", "type": "characterization", "label": "string", "ts": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
PUB app/:appId/xr/marker/detected
Provide detected QR code markers

Operation IDdetected
- #xr
Accepts the following message:
XRMarkerAsyncApiService#detected
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "markerId": "string", "payload": "string", "tags": [ "string" ] }

This example has been generated automatically.
SUB app/:appId/xr/marker/detected
Provide detected QR code markers

Operation IDonDetected
- #xr
Accepts the following message:
XRMarkerAsyncApiService#detected
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "markerId": "string", "payload": "string", "tags": [ "string" ] }

This example has been generated automatically.
PUB app/:appId/xr/marker/changed/:markerId
Provide detected QR code markers

Operation IDchanged
- #xr
Accepts the following message:
XRMarkerAsyncApiService#changed
object
uid: XRMarkerChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "markerId": "string", "payload": "string", "tags": [ "string" ] } }

This example has been generated automatically.
SUB app/:appId/xr/marker/changed/:markerId
Provide detected QR code markers

Operation IDonChanged
- #xr
Accepts the following message:
XRMarkerAsyncApiService#changed
object
uid: XRMarkerChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "operation": "string", "sessionId": "string", "record": { "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "markerId": "string", "payload": "string", "tags": [ "string" ] } }

This example has been generated automatically.
PUB app/:appId/xr/occlusion
Hide the agent model when occluded by a physical obstacle

Operation IDoccluded
- #xr
Accepts the following message:
XROcclusionAsyncApiService#occluded
object
uid: XROcclusionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

occlusion
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "occlusion": true }

This example has been generated automatically.
SUB app/:appId/xr/occlusion
Hide the agent model when occluded by a physical obstacle

Operation IDonOccluded
- #xr
Accepts the following message:
XROcclusionAsyncApiService#occluded
object
uid: XROcclusionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

occlusion
required
boolean
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "occlusion": true }

This example has been generated automatically.
PUB app/:appId/robotics/actuate
Publish a robot actuation event

Operation IDactuate
- #robotics
Accepts the following message:
RoboticsAsyncApiService#actuate
object
uid: ActuationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "actuations": [ "string" ] }

This example has been generated automatically.
SUB app/:appId/robotics/actuate
Subscribe to a robot actuation event

Operation IDonActuate
- #robotics
Accepts the following message:
RoboticsAsyncApiService#actuate
object
uid: ActuationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<string>
Items:
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "actuations": [ "string" ] }

This example has been generated automatically.
PUB app/:appId/robotics/move
Publish a robot movement event

Operation IDmove
- #robotics
Accepts the following message:
RoboticsAsyncApiService#move
object
uid: MovementEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: MovementDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
personId
required
string
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "movement": { "targetPosition": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "personId": "string", "path": [ "string" ] } }

This example has been generated automatically.
SUB app/:appId/robotics/move
Subscribe to a robot movement event

Operation IDonMove
- #robotics
Accepts the following message:
RoboticsAsyncApiService#move
object
uid: MovementEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: MovementDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
personId
required
string
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "movement": { "targetPosition": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "personId": "string", "path": [ "string" ] } }

This example has been generated automatically.
PUB app/:appId/robotics/status
Publish a robot status event

Operation IDrobotStatus
- #robotics
Accepts the following message:
RoboticsAsyncApiService#robotStatus
object
uid: StatusEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: StatusDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
object
uid: VelocityDto
required
object
uid: LinearVelocityDto
Additional properties are allowed.
required
object
uid: LinearVelocityDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
robotId
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "status": { "actualPosition": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "velocity": { "linear": {}, "angular": {} } }, "robotId": "string" }

This example has been generated automatically.
SUB app/:appId/robotics/status
Subscribe to a robot status event

Operation IDonRobotStatus
- #robotics
Accepts the following message:
RoboticsAsyncApiService#robotStatus
object
uid: StatusEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: StatusDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
object
uid: VelocityDto
required
object
uid: LinearVelocityDto
Additional properties are allowed.
required
object
uid: LinearVelocityDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
robotId
required
string
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "status": { "actualPosition": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "velocity": { "linear": {}, "angular": {} } }, "robotId": "string" }

This example has been generated automatically.
PUB app/:appId/robotics/initialpose
Publish a robot initial pose event

Operation IDinitialPose
- #robotics
Accepts the following message:
RoboticsAsyncApiService#initialPose
object
uid: InitialPoseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: InitialPoseDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "initialPose": { "pose": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "covariance": [ "string" ] } }

This example has been generated automatically.
SUB app/:appId/robotics/initialpose
Subscribe to a robot initial pose event

Operation IDonInitialPose
- #robotics
Accepts the following message:
RoboticsAsyncApiService#initialPose
object
uid: InitialPoseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: InitialPoseDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "initialPose": { "pose": { "position": { "x": 0, "y": 0, "z": 0 }, "orientation": { "x": 0, "y": 0, "z": 0, "w": 0 } }, "covariance": [ "string" ] } }

This example has been generated automatically.
PUB app/:appId/robotics/opstate
Publish a robot operational state event

Operation IDopState
- #robotics
Accepts the following message:
RoboticsAsyncApiService#opState
object
uid: OperationalStateEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: OperationalStateDto
op
required
string
state
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "state": { "op": "string", "state": "string" } }

This example has been generated automatically.
SUB app/:appId/robotics/opstate
Subscribe to a robot operational state event

Operation IDonOpState
- #robotics
Accepts the following message:
RoboticsAsyncApiService#opState
object
uid: OperationalStateEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: OperationalStateDto
op
required
string
state
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "appId": "string", "clientId": "string", "userId": "string", "ts": "2019-08-24T14:15:22Z", "state": { "op": "string", "state": "string" } }

This example has been generated automatically.

Schemas

object
uid: PlatformTokenDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

Additional properties are allowed.
object
uid: ModuleResourceDto
resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
object
uid: AppModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
Additional properties are allowed.
RepositoryAssetTypes
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
ModelType
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
ModelGender
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
object
uid: RepositoryAvatarDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
object
uid: RepositoryBackgroundDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
object
uid: RepositoryRobotModelDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: RepositoryDocumentDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
object
uid: RepositoryAnimationDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
object
uid: RepositoryConfigDto
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
object
uid: AppClientDto
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
Additional properties are allowed.
object
uid: LLMSettingsDto
Additional properties are allowed.
object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
InteractionStartTypes
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
ToolsParameterSchemaTypes
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
object
uid: ToolsParameterSchema
parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
Additional properties are allowed.
object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
object
uid: AppToolsDTO
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

Additional properties are allowed.
object
uid: TaskIntentDto
name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

Additional properties are allowed.
TaskEventType
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
object
uid: TaskEventTriggerDto
name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

Additional properties are allowed.
object
uid: TaskEventDto
type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

Additional properties are allowed.
TaskSchemaDataType
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
object
uid: OptionSelection
value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
object
uid: RagDocumentsDto
Additional properties are allowed.
object
uid: PlatformAppDto
appId
required
string
public
boolean
name
required
string
description
required
string
ownerId
required
string
Owner of the application

required
array<object>
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
required
object
uid: RepositoryConfigDto
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
required
array<object>
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
createdAt
string
format: date-time
updatedAt
string
format: date-time
array<object>
Application tools offered by the application

name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

array<object>
Structured tasks offered by the application

taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
allOf
List of RAG documents or urls to import

object
uid: RagDocumentsDto
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlatformAppChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: PlatformAppDto
appId
required
string
public
boolean
name
required
string
description
required
string
ownerId
required
string
Owner of the application

required
array<object>
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
required
object
uid: RepositoryConfigDto
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
modelType
required
string
uid: ModelType
Allowed values:
"readyplayerme"
"custom"
gender
required
string
uid: ModelGender
Allowed values:
"M"
"F"
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: AvatarCameraConfig
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: Point3D
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
prompt
string
object
uid: AvatarTTSOptions
provider
string
model
string
Additional properties are allowed.
required
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryBackgroundMetadataDto
credits
string
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
videoUrl
required
string
object
uid: RobotMapDto
imageUrl
string
width
number
height
number
originOffsetX
number
originOffsetY
number
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
array<object>
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
Additional properties are allowed.
required
array<object>
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
createdAt
string
format: date-time
updatedAt
string
format: date-time
array<object>
Application tools offered by the application

name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

array<object>
Structured tasks offered by the application

taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
allOf
List of RAG documents or urls to import

object
uid: RagDocumentsDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlatformAppClientChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppClientDto
appId
string
name
required
string
clientId
string
The clientId, must be unique in the client list and in uuid format.

secret
string
required
array<string>
A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User . for all permission

Items:
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlatformAppModuleConfigEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: AppModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
appId
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: UpdateUserEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

enabled
required
boolean
Additional properties are allowed.
object
uid: PlatformModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
Additional properties are allowed.
object
uid: ModuleConfigEventDto
required
object
Additional properties are allowed.
ts
required
string
format: date-time
required
object
uid: PlatformModuleConfigDto
moduleId
required
string
status
string
Status of the module. enabled by default. can be disabled. Set to failure if loading generates errors.

name
string
description
string
required
array<string>
Items:
string
required
object
uid: ModuleSettingsDto
url
string
Service URL used to load .well-known

openapiSpec
required
string
Reference to a openapi specification to use to map requests to the modules

asyncapiSpec
required
string
Reference to a asyncAPI specification to use to map requests to the modules

required
array<object>
List of managed resources and scopes for this module

resource
required
string
Resource of the module operation

scope
required
string
Scope of the module operation

array<string>
Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId

Items:
string
name
string
Name of the module operation

description
string
Description of the module operation

moduleId
required
string
Unique identifier of the module

operationId
required
string
Operation to call from the module OpenAPI spec

emitEvent
boolean
Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId///[...context]

Additional properties are allowed.
secret
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
object
uid: StringInferenceValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
object
uid: UserDetectionDto
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: UserDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

cameraId
required
string
source
required
string
required
array<object>
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<string>
Items:
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
required
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: UserInteractionIntentionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

moduleId
required
string
Module generating the event

source
required
string
probability
required
number
interactionType
required
string
Allowed values:
"start"
"stop"
sessionId
required
string
Additional properties are allowed.
object
uid: UserEmotionValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserAgeValue
probability
required
number
value
required
number
Additional properties are allowed.
object
uid: UserCharacterizationDto
required
object
uid: UserEmotionValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserAgeValue
probability
required
number
value
required
number
Additional properties are allowed.
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserCharacterizationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
required
object
uid: UserEmotionValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: UserAgeValue
probability
required
number
value
required
number
Additional properties are allowed.
array<object>
A list of matching inferred user identifiers

probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
object
uid: AudioClassificationValue
probability
required
number
value
required
string
Additional properties are allowed.
object
uid: AudioClassificationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

source
required
string
required
array<object>
probability
required
number
value
required
string
sessionId
string
Additional properties are allowed.
object
uid: ObjectDetectionDto
probability
required
number
value
required
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: ObjectDetectionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<object>
probability
required
number
value
required
string
required
object
uid: BoundingBox
x
required
number
y
required
number
w
required
number
h
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: QRCodeEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

version
required
string
payload
required
string
sessionId
string
Additional properties are allowed.
object
uid: NoiseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

noiseType
required
string
level
required
string
required
array<string>
Items:
string
Additional properties are allowed.
DialogueActor
string
uid: DialogueActor
Actor providing the text, can be user or agent

Allowed values:
"user"
"agent"
object
uid: DialogueMessageDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
User session identifier

actor
string
uid: DialogueActor
Actor providing the text, can be user or agent

Allowed values:
"user"
"agent"
text
required
string
Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.

gender
string
Assistant gender (M or F)

language
string
Text language

emotion
string
User emotion, if available

allOf
LLM engine to use

object
uid: LLMSettingsDto
Additional properties are allowed.
avatar
string
The avatar id used for interaction

messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

ttsEnabled
boolean
Toggle TTS rendering for this message

Default value:true
Additional properties are allowed.
object
uid: Buffer
Additional properties are allowed.
object
uid: SermasSessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

Additional properties are allowed.
object
uid: DialogueTaskChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
object
uid: DialogueTaskProgressDto
type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
allOf
Task

object
uid: DialogueTaskDto
taskId
required
string
Task ID

appId
required
string
Application ID references

sessionId
string
Session ID references

name
required
string
Task name

label
required
string
Task label

description
string
Task description

array<object>
A list of intents to evaluate when the user interacts with the agent

name
required
string
Intent name used as identifier

description
string
Intent description used to match with user input

array<object>
Map task events

type
required
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
message
string
Chat message to send to the user

condition
string
Condition to trigger the event

array<object>
Trigger a tool

name
string
Tool to trigger

allOf
Tool values passed to the tool handlers

object
Additional properties are allowed.
condition
string
Evalute the condition based on values. {key} is replaced with its value.

required
array<object>
Task fields

name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

allOf
Task options

object
uid: TaskOptionsDto
triggerOnce
boolean
Trigger this task once, then remove it

removeRecord
boolean
Remove record on completion

enableTool
boolean
Enable this task as tool, allowing users to invoke it directly

allOf
Additional tool options configuration

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
repositoryId
string
ID of the tool repository to add the tool to

list
boolean
Show this tool to the user, such as in the welcome message

oncePerSession
boolean
Allow this task to be completed only once per session

matchOrRemove
boolean
Cancel the task if the user answer does not match one of the task options

Additional properties are allowed.
Additional properties are allowed.
required
allOf
Task field

object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueTaskRecordChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueTaskRecordDto
recordId
required
string
Record ID

taskId
required
string
Task ID

appId
required
string
Application ID reference

sessionId
required
string
Session ID reference

status
string
uid: TaskEventType
Event type

Allowed values:
"started"
"completed"
"ongoing"
"aborted"
required
object
Stored values

Default value:{}
Additional properties are allowed.
updated
string
format: date-time
Updated date

created
string
format: date-time
Creation date

Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueTaskRecordHandlerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

taskId
required
string
Task Id

recordId
required
string
Record Id

required
allOf
Field reference

object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueToolTriggeredEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

name
required
string
required
object
uid: AppToolsDTO
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueToolsRepositoryRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

repositoryId
string
Tool repository ID

allOf
Tool repository options

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
array<array<any>>
Tools list

array<any>
Additional properties are allowed.
object
uid: DialogueToolsRepositoryChanged
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: DialogueToolsRepositoryRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

repositoryId
string
Tool repository ID

allOf
Tool repository options

object
uid: DialogueToolsRepositoryOptionsDto
triggerOnce
boolean
Trigger one of the tools in the list once, then remove the tools.

exclusive
boolean
Alter the normal chat flow, assuming one of the available tools will provide an answer.

Additional properties are allowed.
array<array<any>>
Tools list

array<any>
Additional properties are allowed.
Additional properties are allowed.
object
uid: DialogueToolNotMatchingEventDto
appId
required
string
sessionId
required
string
required
array<object>
name
required
string
Tool name used in the LLM, a descriptive name may help in identifying it correctly

description
required
string
Tool description used in the LLM, this is key to correctly match the user intent

array<object>
List of parameters of the tool

parameter
required
string
function parameter name

type
required
string
uid: ToolsParameterSchemaTypes
parameter type (one of string,number,boolean,object)

Allowed values:
"string"
"number"
"boolean"
"object"
description
required
string
description for the parameter, useful to give an hint while matching from the user input

ignore
boolean
flag as required

anyOf
provide a predefined value, useful to fill data otherwise missing from the context

Can adhere to:
string
Or to:
number
Or to:
boolean
allOf
Provide details to trigger an HTTP API call on tool match

object
uid: ToolsRequestSchema
auth
string
Supported options are basic, bearer and module. Defaults to module if not specified.

allOf
Used for "basic" auth type

object
uid: ToolsRequestSchemaAuthBasic
username
string
password
required
string
Additional properties are allowed.
allOf
Used for "bearer" auth type

object
uid: ToolsRequestSchemaAuthBearer
clientType
string
Supported options are "client_credentials" or "password".

clientId
string
Required for client type "client_credentials"

clientSecret
string
Required for client type "client_credentials"

username
string
Required for client type "password"

password
string
Required for client type "password"

audience
string
tokenUrl
required
string
refreshUrl
string
Additional properties are allowed.
moduleId
required
string
Reference to one of the modules (or clients) available in the app

url
required
string
Url to call with a JSON POST. Leave empty to skip API calling

object
Additional properties are allowed.
Additional properties are allowed.
emitter
string
Internal event emitted on match

returnDirect
boolean
skipResponse
boolean
Ignore the LLM response when the tool matches

url
string
API url to call on tool match, defaults to unauthenticated POST if no request are provided.

required
array<string>
Items:
string
taskId
string
object
uid: TaskFieldDto
name
required
string
Name of the field

label
string
Label of the field

order
number
Priority order (lower first)

type
required
string
uid: TaskSchemaDataType
Data type

Allowed values:
"text"
"boolean"
"date"
"select"
"eval"
"external"
required
boolean
Indicate if the field is required

Default value:false
validation
string
A prompt to validate and transform the input

condition
string
Provde an activation condition based on the stored record list. If omitted, the field is always proposed to the user.

prompt
string
Provde a prompt for type=evaluate based on the available record fields. Placeholders such as {field-name} are replaced with the value of the field.

handler
string
Provde an handler for type=external to delegate the field handling to an external service

multiple
boolean
Allow to select multiple options

array<object>
List of valid options

value
required
string
Selection value

label
string
Selection label (value is used if not provided)

description
string
Description for an option

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
agentId
string
Agent instance associated to the session

array<string>
Collect inferred identifiers of user interacting with the agent during a session.

Items:
string
modifiedAt
required
string
format: date-time
createdAt
required
string
format: date-time
closedAt
required
string
format: date-time
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionProperties
repositoryId
string
Reference to the current tool repository

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionSupportEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

supportId
required
string
status
required
string
feedback
required
string
code
required
string
Additional properties are allowed.
object
uid: SessionStorageRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

storageId
string
sessionId
string
required
object
Additional properties are allowed.
Additional properties are allowed.
object
uid: SessionStorageEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: SessionStorageRecordDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

storageId
string
sessionId
string
required
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
AgentStatus
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: AgentChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
moduleId
required
string
required
object
uid: AgentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

agentId
required
string
status
required
string
uid: AgentStatus
Allowed values:
"unavailable"
"error"
"not_ready"
"ready"
"loading"
"interacting"
"waiting"
"processing"
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: AppSettingsDto
skipToolResponse
boolean
Skip the default tools response as generated by the LLM

ttsEnabled
boolean
Toggle text to speech (TTS) rendering

login
boolean
App requires login

chatModeEnabled
boolean
Toggle the free chat mode, enabled by default

Default value:true
avatar
required
string
Avatar ID

language
string
Default interaction language such as en-GB

allOf
LLM models settings

object
uid: LLMSettingsDto
Additional properties are allowed.
background
required
string
Kisok background image ID

allOf
Application prompt to describe the scope of the application

object
uid: AppPromptDto
text
required
string
Additional properties are allowed.
skipWelcomeMessage
boolean
Toggle the welcome message sent at the start of a session

interactionStart
string
uid: InteractionStartTypes
An interaction modality to start a session

Allowed values:
"on-load"
"touch"
"speak"
"intent-detection"
object
Kiosk colors theme

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: UIAssetDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
filename
string
appId
required
string
userId
string
ts
string
format: date-time
Additional properties are allowed.
object
uid: UIAssetChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: UIAssetDto
id
required
string
type
required
string
uid: RepositoryAssetTypes
Allowed values:
"avatars"
"backgrounds"
"robots"
"documents"
"animations"
name
string
path
required
string
object
uid: RepositoryAssetMetadataDto
Additional properties are allowed.
filename
string
appId
required
string
userId
string
ts
string
format: date-time
Additional properties are allowed.
Additional properties are allowed.
object
uid: UIContentMetadataDto
repositoryId
string
Reference to a tool repository ID

Additional properties are allowed.
object
uid: UIContentOptionsDto
clearScreen
boolean
Clear the UI screen

ttsEnabled
boolean
Enable agent reading the content (text to speech)

stopSpeech
boolean
Stop the agent speech

language
string
Define the language of the content, it will be translated based on the language selected by the user.

Additional properties are allowed.
SupportedContentTypes
string
uid: SupportedContentTypes
Allowed values:
"video"
"image"
"pdf"
"webpage"
"object"
"text"
"email"
"html"
"link"
"dialogue-message"
"navigation"
"buttons"
"quiz"
"clear-screen"
"qrcode-scanner"
object
uid: UIContentDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

contentType
required
string
uid: SupportedContentTypes
Allowed values:
"video"
"image"
"pdf"
"webpage"
"object"
"text"
"email"
"html"
"link"
"dialogue-message"
"navigation"
"buttons"
"quiz"
"clear-screen"
"qrcode-scanner"
required
object
Additional properties are allowed.
description
string
Provide a description for the content

allOf
Provides metadata for the content

object
uid: UIContentMetadataDto
repositoryId
string
Reference to a tool repository ID

Additional properties are allowed.
object
Additional properties are allowed.
allOf
Provides configuration options for the content

object
uid: UIContentOptionsDto
clearScreen
boolean
Clear the UI screen

ttsEnabled
boolean
Enable agent reading the content (text to speech)

stopSpeech
boolean
Stop the agent speech

language
string
Define the language of the content, it will be translated based on the language selected by the user.

Additional properties are allowed.
object
Additional properties are allowed.
messageId
string
Unique sortable ID used to group and sort messages

chunkId
string
Unique sortable ID used to sort chunks from the same messageId

Additional properties are allowed.
object
uid: UIInteractionDTO
required
object
Additional properties are allowed.
element
required
string
value
required
string
Additional properties are allowed.
object
uid: UIInteractionEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

sessionId
string
Track the interaction session, if available

moduleId
required
string
required
object
uid: UIInteractionDTO
required
object
Additional properties are allowed.
element
required
string
value
required
string
Additional properties are allowed.
Additional properties are allowed.
LogType
string
uid: LogType
Allowed values:
"characterization"
"stt"
"tts"
"interaction"
"session"
"document"
"chat"
"task"
"performance"
"kpi"
"error"
object
uid: MonitoringRecordDto
appId
required
string
sessionId
required
string
type
string
uid: LogType
Allowed values:
"characterization"
"stt"
"tts"
"interaction"
"session"
"document"
"chat"
"task"
"performance"
"kpi"
"error"
label
required
string
ts
required
string
format: date-time
Additional properties are allowed.
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
object
uid: XRMarkerChangedDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

operation
required
string
sessionId
string
required
object
uid: XRMarkerDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

markerId
string
ID of the marker

payload
required
string
Payload as decoded from the marker QR code

array<string>
A list of tags for the marker

Items:
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: XROcclusionDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

occlusion
required
boolean
Additional properties are allowed.
object
uid: ActuationEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
array<string>
Items:
string
Additional properties are allowed.
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
object
uid: MovementDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
personId
required
string
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: MovementEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: MovementDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
personId
required
string
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: LinearVelocityDto
Additional properties are allowed.
object
uid: VelocityDto
required
object
uid: LinearVelocityDto
Additional properties are allowed.
required
object
uid: LinearVelocityDto
Additional properties are allowed.
Additional properties are allowed.
object
uid: StatusDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
object
uid: VelocityDto
required
object
uid: LinearVelocityDto
Additional properties are allowed.
required
object
uid: LinearVelocityDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: StatusEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: StatusDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
object
uid: VelocityDto
required
object
uid: LinearVelocityDto
Additional properties are allowed.
required
object
uid: LinearVelocityDto
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
robotId
required
string
Additional properties are allowed.
object
uid: InitialPoseDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
array<string>
Items:
string
Additional properties are allowed.
object
uid: InitialPoseEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: InitialPoseDto
required
object
uid: PoseDto
required
object
uid: PositionDto
x
required
number
y
required
number
z
required
number
Additional properties are allowed.
required
object
uid: OrientationDto
x
required
number
y
required
number
z
required
number
w
required
number
Additional properties are allowed.
Additional properties are allowed.
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: OperationalStateDto
op
required
string
state
required
string
Additional properties are allowed.
object
uid: OperationalStateEventDto
appId
required
string
clientId
string
Reference to the authenticated client the request originated from

userId
string
Reference to the user interacting with the system

ts
string
format: date-time
Reference date

required
object
uid: OperationalStateDto
op
required
string
state
required
string
Additional properties are allowed.
Additional properties are allowed.

Sermas Events 1.0

Servers

Operations

PUB app/:appId/platform/token

Examples

This example has been generated automatically.

SUB app/:appId/platform/token

Examples

This example has been generated automatically.

PUB app/:appId/platform/app/changed/:appId

Examples

This example has been generated automatically.

SUB app/:appId/platform/app/changed/:appId

Examples

This example has been generated automatically.

PUB app/:appId/platform/client/changed/:clientId

Examples

This example has been generated automatically.

SUB app/:appId/platform/client/changed/:clientId

Examples

This example has been generated automatically.

PUB app/:appId/platform/module

Examples

This example has been generated automatically.

SUB app/:appId/platform/module

Examples

This example has been generated automatically.

PUB app/:appId/auth/update

Examples

This example has been generated automatically.

SUB app/:appId/auth/update

Examples

This example has been generated automatically.

PUB app/:appId/auth/create

Examples

This example has been generated automatically.

SUB app/:appId/auth/create

Examples

This example has been generated automatically.

PUB app/:appId/auth/login

Examples

This example has been generated automatically.

SUB app/:appId/auth/login

Examples

This example has been generated automatically.

PUB system/platform/module/changed/:moduleId

Examples

This example has been generated automatically.

SUB system/platform/module/changed/:moduleId

Examples

This example has been generated automatically.

PUB app/:appId/detection/user

Examples

This example has been generated automatically.

SUB app/:appId/detection/user

Examples

This example has been generated automatically.

PUB app/:appId/detection/interaction

Examples

This example has been generated automatically.

SUB app/:appId/detection/interaction

Examples

This example has been generated automatically.

PUB app/:appId/detection/characterization

Examples

This example has been generated automatically.

SUB app/:appId/detection/characterization

Examples

This example has been generated automatically.

PUB app/:appId/detection/audio

Examples

This example has been generated automatically.

SUB app/:appId/detection/audio

Examples

This example has been generated automatically.

PUB app/:appId/detection/object

Examples

This example has been generated automatically.

SUB app/:appId/detection/object

Examples