MODE Developer Central

Get an assistant

GET/projects/{projectId}/entities/{entityId}/assistants/{assistantId}

Base URL: https://api.tinkermode.com

Return the assistant with the specified ID.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain the key of a user or service account with permissions to read assistant of the entity, or a project API key.

Path parameters

NameTypeRequiredConstraintsDescription
projectIdintegerYesThe unique ID for a specified project.
entityIdstringYesEntity ID (unique within project)
assistantIdintegerYesThe unique ID for a specific assistant.

Responses

200 Successfully retrieved the specified assistant.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
chatPlatformunknownYesread-only (server-generated); one of: slack, msTeams, directIdentifies one of the supported chat platforms that this AI Assistant instance is integrated with.
createdAtstringNoread-only (server-generated); format: date-timeInstance creation timestamp.
descriptionstringNoAdditional information about AI Assistant.
directConfigobjectNoThis field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.
Properties of directConfig
PropertyTypeRequiredConstraintsDescription
defaultEntityAccessRuleobjectYesDefault rule of access to entities and their data.
Properties of defaultEntityAccessRule
PropertyTypeRequiredConstraintsDescription
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also included.
defaultQaRuleobjectYesDefault rule of access to Question-Answering data files.
Properties of defaultQaRule
PropertyTypeRequiredConstraintsDescription
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
domainIdstringYesdomainID connected to Assistant instance.
entityAccessRulesarray<object>NoEntity access rules applied to specific channels. These override the default rule.
Properties of entityAccessRules
PropertyTypeRequiredConstraintsDescription
channelstringNoRoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also included.
qaRulesarray<object>NoQA files access rules applied to specific channels. These override the default rule.
Properties of qaRules
PropertyTypeRequiredConstraintsDescription
channelstringNoRoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
entityIDstringNoread-only (server-generated)Optional. If present, this identifies the entity instane associated with the AI Assistant instance.
idintegerYesread-only (server-generated)The unique identifier for the AI assistant instance.
msTeamsConfigobjectNoThis field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.
Properties of msTeamsConfig
PropertyTypeRequiredConstraintsDescription
defaultEntityAccessRuleobjectYesDefault rule of access to entities and their data.
Properties of defaultEntityAccessRule
PropertyTypeRequiredConstraintsDescription
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also included.
defaultQaRuleobjectYesDefault rule of access to Question-Answering data files.
Properties of defaultQaRule
PropertyTypeRequiredConstraintsDescription
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
entityAccessRulesarray<object>NoEntity access rules applied to specific channels. These override the default rule.
Properties of entityAccessRules
PropertyTypeRequiredConstraintsDescription
channelstringNoChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also included.
qaRulesarray<object>NoQA files access rules applied to specific channels. These override the default rule.
Properties of qaRules
PropertyTypeRequiredConstraintsDescription
channelstringNoChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
tenantIdstringYestenantID connected to Assistant instance.
namestringYesDisplay name of AI Assistant.
projectIdintegerYesread-only (server-generated)The unique identifier for the project the AI Assistant instance belongs to.
slackConfigobjectNoThis field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.
Properties of slackConfig
PropertyTypeRequiredConstraintsDescription
defaultEntityAccessRuleobjectYesDefault rule of access to entities and their data.
Properties of defaultEntityAccessRule
PropertyTypeRequiredConstraintsDescription
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also inlcuded.
defaultQaRuleobjectYesDefault rule of access to Question-Answering data files.
Properties of defaultQaRule
PropertyTypeRequiredConstraintsDescription
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
entityAccessRulesarray<object>NoEntity access rules applied to specific Slack channels. These override the default rule.
Properties of entityAccessRules
PropertyTypeRequiredConstraintsDescription
channelstringNoChannelID of a channel or 'DM'.
entityIdsarray<string>NoList of entity instances that are accessible. The instances' descendants are also included.
qaRulesarray<object>NoQA files access rules applied to specific Slack channels. These override the default rule.
Properties of qaRules
PropertyTypeRequiredConstraintsDescription
channelstringNoChannelID of a channel or 'DM'.
filesobjectNoSpecification 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
PropertyTypeRequiredConstraintsDescription
tagstringNoThe tag assigned to project files or entity files meant for QA indexing.
tokenStateunknownYesone of: unissued, valid, revokedCurrent state of athentication token issued by Slack to Assistant instance.
workspaceIdstringYesID of Slack workspace connected to Assistant instance.
updatedAtstringNoread-only (server-generated); format: date-timeTimestamp of last update.

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

404 The requested assistant does not exist or is not accessible.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.