aiToolsGetDisabled
Map aiToolsGetDisabled(scope, 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. Without scope the answer is the caller's effective list, with the tools an administrator switched off for everyone folded in; scope=tenant reads that administrator list alone, which is what the settings page shows. 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
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| scope | query | String | [required] | |
| entityId | query | String | The 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 code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The switched-off tools as a map of server type to tool names. An absent type means nothing is switched off for it. | Map | - |
| 400 | scope is not user or tenant. | AiErrorResponse | - |
| 401 | Missing asc_auth_key cookie or Authorization header. | AiErrorResponse | - |
| 403 | AI 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 | - |
| 500 | Unhandled failure. The reason is logged server-side and never echoed back. | AiErrorResponse | - |
Return type
Map
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json