aiToolsSetDisabled
AiSuccessResponse aiToolsSetDisabled(AiToolsSetDisabledRequest)
PUT /api/2.0/ai/tools/set-disabled
Set disabled
Switches off the listed tools of one server type in the scope, so the model is no longer offered them. serverType has to be a key the round's tool filter actually matches - a host-configured system server, one of the two DocSpace integration groups, web search, image generation, or one of the scope's registered custom servers - and an unknown value is rejected with the list of valid ones in the message, rather than stored and silently ignored. toolNames replaces the previous selection for that server type, so send the full list and pass an empty one to switch everything back on. entityId has to name a room the caller can open.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| AiToolsSetDisabledRequest | body | AiToolsSetDisabledRequest | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Confirms the new disable list was stored for that server type. | AiSuccessResponse | - |
| 400 | The list of tools to disable is malformed. | 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 | - |
| 404 | The referenced object does not exist: an unknown or deleted room named by entityId, or an object the caller cannot read - for those the two cases are deliberately indistinguishable. | AiErrorResponse | - |
| 413 | The request body is larger than 100 KB, the JSON parser's limit on this route. | AiErrorResponse | - |
| 500 | Unhandled failure. The reason is logged server-side and never echoed back. | AiErrorResponse | - |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json