MODE Developer Central

Get AI Assistant instances

GET/assistants

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

Get a list of AI Assistant instances. Either projectId or userId is required. They are mutually exclusive, and a request that combines them is rejected with a 400 INVALID_REQUEST response.

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 instances, or a project API key.

Query parameters

NameTypeRequiredConstraintsDescription
limitintegerNodefault: 25; min: 1Maximum number of items to return.
onlyProjectAssistantsbooleanNoReturn only Project Assistants when true is specified.
projectIdintegerNoReturn Assistant instances of the specified project. The caller must contain the API key of a user who has permission to all assistants of a project, or a Project API Key.
skipintegerNodefault: 0; min: 0Number of items to skip over.
userIdintegerNoReturn Assistant instances that a particular user has access to. The caller must contain the API key of the user, the API key of a user who has permission to all resources of a project, or a Project API Key with admin permission.

Responses

200 Successfully retrieved the assistant instances.

Content type: application/json

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

An array of objects with the following shape:

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.

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.