Assistant Instances data models

Represents an instance of AI Assistant associated with a project or entity.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
chatPlatform	unknown	Yes	read-only (server-generated); one of: slack, msTeams, direct	Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.
createdAt	string	No	read-only (server-generated); format: date-time	Instance creation timestamp.
description	string	No		Additional information about AI Assistant.
directConfig	object	No		This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.
Properties of directConfig Property Type Required Constraints Description defaultEntityAccessRule object Yes Default rule of access to entities and their data. Properties of defaultEntityAccessRule Property Type Required Constraints Description entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also included. defaultQaRule object Yes Default rule of access to Question-Answering data files. Properties of defaultQaRule Property Type Required Constraints Description files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing. domainId string Yes domainID connected to Assistant instance. entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule. Properties of entityAccessRules Property Type Required Constraints Description channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM. entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also included. qaRules array<object> No QA files access rules applied to specific channels. These override the default rule. Properties of qaRules Property Type Required Constraints Description channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM. files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing.
entityID	string	No	read-only (server-generated)	Optional. If present, this identifies the entity instane associated with the AI Assistant instance.
id	integer	Yes	read-only (server-generated)	The unique identifier for the AI assistant instance.
msTeamsConfig	object	No		This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.
Properties of msTeamsConfig Property Type Required Constraints Description defaultEntityAccessRule object Yes Default rule of access to entities and their data. Properties of defaultEntityAccessRule Property Type Required Constraints Description entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also included. defaultQaRule object Yes Default rule of access to Question-Answering data files. Properties of defaultQaRule Property Type Required Constraints Description files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing. entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule. Properties of entityAccessRules Property Type Required Constraints Description channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'. entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also included. qaRules array<object> No QA files access rules applied to specific channels. These override the default rule. Properties of qaRules Property Type Required Constraints Description channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'. files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing. tenantId string Yes tenantID connected to Assistant instance.
name	string	Yes		Display name of AI Assistant.
projectId	integer	Yes	read-only (server-generated)	The unique identifier for the project the AI Assistant instance belongs to.
slackConfig	object	No		This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.
Properties of slackConfig Property Type Required Constraints Description defaultEntityAccessRule object Yes Default rule of access to entities and their data. Properties of defaultEntityAccessRule Property Type Required Constraints Description entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also inlcuded. defaultQaRule object Yes Default rule of access to Question-Answering data files. Properties of defaultQaRule Property Type Required Constraints Description files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing. entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule. Properties of entityAccessRules Property Type Required Constraints Description channel string No ChannelID of a channel or 'DM'. entityIds array<string> No List of entity instances that are accessible. The instances' descendants are also included. qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule. Properties of qaRules Property Type Required Constraints Description channel string No ChannelID of a channel or 'DM'. files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. Properties of files Property Type Required Constraints Description tag string No The tag assigned to project files or entity files meant for QA indexing. tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance. workspaceId string Yes ID of Slack workspace connected to Assistant instance.
updatedAt	string	No	read-only (server-generated); format: date-time	Timestamp of last update.

A Direct room associated with an Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
id	string	Yes	read-only (server-generated)	The unique identifier for the Direct room.
name	string	Yes	read-only (server-generated)	The name of the Direct room.

Represents an event subscription for an AI Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
actions	array<object>	Yes		The actions to take when the event is triggered.
Properties of actions Property Type Required Constraints Description config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type. Properties of config Property Type Required Constraints Description notificationTarget object No The target to send notifications to. Properties of notificationTarget Property Type Required Constraints Description directTargets array<object> No Direct rooms to send notifications to. Nested structure continues below this depth. msTeamsTargets array<object> No MS Teams channels to send notifications to. Nested structure continues below this depth. slackTargets array<object> No Slack channels to send notifications to. Nested structure continues below this depth. type unknown No one of: send_message The type of action to perform.
assistantId	integer	Yes		The unique identifier for the AI Assistant instance this event subscription belongs to.
createdAt	string	No	read-only (server-generated); format: date-time	Timestamp when the event subscription was created.
description	string	No		A description of the event subscription.
disabled	boolean	No		Whether the event subscription is disabled.
eventType	string	Yes		The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.
id	integer	No	read-only (server-generated)	The unique identifier for the event subscription.
name	string	Yes		Display name of the event subscription.
projectId	integer	Yes		The unique identifier for the project the event subscription belongs to.
updatedAt	string	No	read-only (server-generated); format: date-time	Timestamp when the event subscription was last updated.

A Microsoft Teams team associated with an Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
channels	array<object>	Yes
Properties of channels Property Type Required Constraints Description id string Yes read-only (server-generated) The unique identifier for the channel. name string Yes read-only (server-generated) The name of the channel.
id	string	Yes	read-only (server-generated)	The unique identifier for the Team.
name	string	Yes	read-only (server-generated)	The name of the Team.

A Slack channel associated with an Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
id	string	Yes	read-only (server-generated)	The unique identifier for the Slack Channel.
name	string	Yes	read-only (server-generated)	The name of the Slack Channel.