Skip to main content

aiToolsGetDisabled

Map aiToolsGetDisabled(entityId)

GET /api/2.0/ai/tools/get-disabled

Get disabled

Returns the tools switched off in the scope, as a map of server type to tool names. entityId picks the scope and omitting it reads the portal-wide setting. An absent server type means nothing is switched off for it, so an empty answer means every tool is on offer. Use GET api/2.0/ai/tools/is-tool-disabled to ask about one tool instead of reading the whole map.

Parameters​

NameInTypeDescriptionNotes
entityIdqueryStringThe DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.[optional] [example: 1234]

Responses​

Status codeDescriptionTypeResponse headers
200The switched-off tools as a map of server type to tool names. An absent type means nothing is switched off for it.Map-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

Map

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json