aiPreferencesIsDeepModeSet
Boolean aiPreferencesIsDeepModeSet(entityId)
GET /api/2.0/ai/preferences/is-deep-mode-set
Is deep mode set
Tells whether a scope has an explicitly persisted extended-thinking setting of its own, as opposed to inheriting the configured default. entityId picks a room and omitting it asks about the portal-wide preference. A true answer means a value was stored, whether that value is on or off - read the value itself with GET api/2.0/ai/preferences/get-deep-mode. This is the check a settings screen uses to show an explicit override rather than an inherited state.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| 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 | Whether the scope has a preference of its own, whichever way that preference is set. | Boolean | - |
| 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
Boolean
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json