Settings
52 methods on the Settings resource.
52 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";52 of 52
applySettingsUpdatebeginSettingsMCPAuthcancelSettingsUpdatecheckSettingsUpdatecompleteMCPAuthCallbackdeleteSettingsHookdeleteSettingsMCPServerdeleteSettingsProviderexchangeSettingsMCPAuthgetSettingsAttentiongetSettingsAutomationgetSettingsCmdPalettegetSettingsGeneralgetSettingsHooksExtensionsgetSettingsMCPAuthStatusgetSettingsMCPServergetSettingsMarketplacegetSettingsObservabilitygetSettingsPersonagetSettingsProvidergetSettingsProviderUsagegetSettingsRestartStatusgetSettingsRolesgetSettingsShellgetSettingsSkillsgetSettingsUpdategetSettingsWindowManagerlistSettingsApplyRecordslistSettingsHookslistSettingsMCPServerslistSettingsProviderslogoutSettingsMCPAuthputSettingsHookputSettingsMCPServerputSettingsProviderreloadSettingssetSettingsProviderEnabledstreamSettingsObservabilityLogTailssetriggerSettingsRestartupdateSettingsAttentionupdateSettingsAutomationupdateSettingsCmdPaletteupdateSettingsGeneralupdateSettingsHooksExtensionsupdateSettingsMarketplaceupdateSettingsObservabilityupdateSettingsPersonaupdateSettingsProviderUsageupdateSettingsRolesupdateSettingsShellupdateSettingsSkillsupdateSettingsWindowManager
applySettingsUpdate
Durably acquire an asynchronous software update operation
compozy.settings.applySettingsUpdate({ body }) → Promise<SettingsUpdateApplyResponse>
Request bodySettingsUpdateApplyRequest
POST /api/settings/update/applyapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.applySettingsUpdate({ body: { /* request fields */ } });beginSettingsMCPAuth
Begin daemon-mediated OAuth for one MCP server
compozy.settings.beginSettingsMCPAuth({ path, query, body }) → Promise<SettingsMCPAuthBeginResponse>
Options
- namestringpathrequired
- Configured MCP server name
- scope"user" | "profile" | "workspace"queryrequired
- Exact MCP settings scope
- workspace_idstringquery
- Required when scope is workspace
- profilestringquery
- Required when scope is profile
- ownerstringquery
- Definition owner: manual or extension:<name>; omitted owner selects manual
Request bodySettingsMCPAuthBeginRequest
POST /api/settings/mcp-servers/{name}/auth/beginapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.beginSettingsMCPAuth({ path: { "name": "name" }, query: { "scope": "user" }, body: { /* request fields */ } });cancelSettingsUpdate
Cancel and archive a dormant software update operation
compozy.settings.cancelSettingsUpdate() → Promise<SettingsUpdateCancelResponse>
POST /api/settings/update/cancelapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.cancelSettingsUpdate();checkSettingsUpdate
Refresh update discovery, limited to one upstream check per minute
compozy.settings.checkSettingsUpdate() → Promise<SettingsUpdateResponse>
POST /api/settings/update/checkapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.checkSettingsUpdate();completeMCPAuthCallback
Complete a loopback MCP OAuth browser redirect
compozy.settings.completeMCPAuthCallback({ query }) → Promise<string>
Options
- codestringquery
- Authorization code returned by the provider
- statestringqueryrequired
- Single-use OAuth state
- errorstringquery
- OAuth error returned by the provider
GET /api/mcp/oauth/callbackapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.completeMCPAuthCallback({ query: { "state": "state" } });deleteSettingsHook
Delete one settings-backed hook declaration
compozy.settings.deleteSettingsHook({ path, query }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- Hook name
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
DELETE /api/settings/hooks/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.deleteSettingsHook({ path: { "name": "name" } });deleteSettingsMCPServer
Delete a manual MCP server or reset its extension override
compozy.settings.deleteSettingsMCPServer({ path, query }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- MCP server name
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
- ownerstringquery
- Select manual or extension:<name>; omitted owner selects manual servers only
- target"auto" | "config" | "sidecar"query
- Select the persistence target
DELETE /api/settings/mcp-servers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.deleteSettingsMCPServer({ path: { "name": "name" } });deleteSettingsProvider
Delete one settings-backed provider overlay
compozy.settings.deleteSettingsProvider({ path }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- Provider name
DELETE /api/settings/providers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.deleteSettingsProvider({ path: { "name": "name" } });exchangeSettingsMCPAuth
Complete daemon-mediated OAuth for one MCP server
compozy.settings.exchangeSettingsMCPAuth({ path, query, body }) → Promise<SettingsMCPAuthStatusPayload>
Options
- namestringpathrequired
- Configured MCP server name
- scope"user" | "profile" | "workspace"queryrequired
- Exact MCP settings scope
- workspace_idstringquery
- Required when scope is workspace
- profilestringquery
- Required when scope is profile
- ownerstringquery
- Definition owner: manual or extension:<name>; omitted owner selects manual
Request bodySettingsMCPAuthExchangeRequest
POST /api/settings/mcp-servers/{name}/auth/exchangeapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.exchangeSettingsMCPAuth({ path: { "name": "name" }, query: { "scope": "user" }, body: { /* request fields */ } });getSettingsAttention
Read the operator attention settings section
compozy.settings.getSettingsAttention({ query }) → Promise<SettingsAttentionResponse>
Options
- scope"user" | "profile"query
- Select user or profile attention mutes
- profilestringquery
- Select the profile whose workspace mutes are returned
GET /api/settings/attentionapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsAttention();Show all 52 methods
getSettingsAutomation
Read the automation settings section
compozy.settings.getSettingsAutomation() → Promise<SettingsAutomationResponse>
GET /api/settings/automationapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsAutomation();getSettingsCmdPalette
Read command-palette settings
compozy.settings.getSettingsCmdPalette({ query }) → Promise<SettingsCmdPaletteResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
GET /api/settings/cmd-paletteapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsCmdPalette();getSettingsGeneral
Read the general settings section
compozy.settings.getSettingsGeneral() → Promise<SettingsGeneralResponse>
GET /api/settings/generalapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsGeneral();getSettingsHooksExtensions
Read the hooks and extensions settings section
compozy.settings.getSettingsHooksExtensions() → Promise<SettingsHooksExtensionsResponse>
GET /api/settings/hooks-extensionsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsHooksExtensions();getSettingsMCPAuthStatus
Get redacted daemon-mediated OAuth state for one MCP server
compozy.settings.getSettingsMCPAuthStatus({ path, query }) → Promise<SettingsMCPAuthStatusPayload>
Options
- namestringpathrequired
- Configured MCP server name
- scope"user" | "profile" | "workspace"queryrequired
- Exact MCP settings scope
- workspace_idstringquery
- Required when scope is workspace
- profilestringquery
- Required when scope is profile
- ownerstringquery
- Definition owner: manual or extension:<name>; omitted owner selects manual
GET /api/settings/mcp-servers/{name}/auth/statusapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsMCPAuthStatus({ path: { "name": "name" }, query: { "scope": "user" } });getSettingsMCPServer
Get one owner-qualified MCP server
compozy.settings.getSettingsMCPServer({ path, query }) → Promise<SettingsMCPServerResponse>
Options
- namestringpathrequired
- Logical MCP name with owner, otherwise manual or allocated runtime name
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
- ownerstringquery
- Select manual or extension:<name>; omitted owner selects manual servers only
GET /api/settings/mcp-servers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsMCPServer({ path: { "name": "name" } });getSettingsMarketplace
Read global marketplace catalog settings
compozy.settings.getSettingsMarketplace() → Promise<SettingsMarketplaceResponse>
GET /api/settings/marketplaceapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsMarketplace();getSettingsObservability
Read the observability settings section
compozy.settings.getSettingsObservability() → Promise<SettingsObservabilityResponse>
GET /api/settings/observabilityapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsObservability();getSettingsPersona
Read profile-layerable persona defaults
compozy.settings.getSettingsPersona({ query }) → Promise<SettingsPersonaResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
GET /api/settings/personaapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsPersona();getSettingsProvider
Read one settings-backed provider
compozy.settings.getSettingsProvider({ path }) → Promise<SettingsProviderResponse>
Options
- namestringpathrequired
- Provider name
GET /api/settings/providers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsProvider({ path: { "name": "name" } });getSettingsProviderUsage
Read the provider usage settings section
compozy.settings.getSettingsProviderUsage() → Promise<SettingsProviderUsageResponse>
GET /api/settings/provider-usageapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsProviderUsage();getSettingsRestartStatus
Get the persisted status for one daemon restart operation
compozy.settings.getSettingsRestartStatus({ path }) → Promise<RestartActionStatus>
Options
- operation_idstringpathrequired
- Restart operation id
GET /api/settings/actions/restart/{operation_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsRestartStatus({ path: { "operation_id": "operation_id" } });getSettingsRoles
Read the background-role routing settings section
compozy.settings.getSettingsRoles() → Promise<SettingsRolesResponse>
GET /api/settings/rolesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsRoles();getSettingsShell
Read the operator shell settings section
compozy.settings.getSettingsShell() → Promise<SettingsShellResponse>
GET /api/settings/shellapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsShell();getSettingsSkills
Read the skills settings section
compozy.settings.getSettingsSkills({ query }) → Promise<SettingsSkillsResponse>
Options
- scope"user" | "profile" | "workspace" | "agent"query
- Select the settings scope
- workspace_idstringquery
- Workspace id for workspace or agent resolution context
- profilestringquery
- Profile name when scope=profile
- agent_namestringquery
- Agent name when scope=agent
GET /api/settings/skillsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsSkills();getSettingsUpdate
Read the current CompozyOS software update status
compozy.settings.getSettingsUpdate() → Promise<SettingsUpdateResponse>
GET /api/settings/updateapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsUpdate();getSettingsWindowManager
Read the window-manager settings section
compozy.settings.getSettingsWindowManager({ query }) → Promise<SettingsWindowManagerResponse>
Options
- scope"user" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace id for workspace scope
- client_idstringquery
- Select the shell attachment for shortcut statuses
- client_profilestringquery
- Select the shell profile without changing settings scope
GET /api/settings/window-managerapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.getSettingsWindowManager();listSettingsApplyRecords
List config apply records for desired and active generation reconciliation
compozy.settings.listSettingsApplyRecords({ query }) → Promise<ConfigApplyRecordsResponse>
Options
- status"pending_apply" | "applied" | "blocked" | "failed"query
- Filter by apply status
- actorstringquery
- Filter by config apply actor
- limitintegerquery
- Maximum number of records to return
GET /api/settings/applyapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.listSettingsApplyRecords({ query: { "status": "pending_apply" } });listSettingsHooks
List settings-backed hook declarations
compozy.settings.listSettingsHooks({ query }) → Promise<SettingsHooksResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
GET /api/settings/hooksapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.listSettingsHooks();listSettingsMCPServers
List manual and extension-owned MCP servers
compozy.settings.listSettingsMCPServers({ query }) → Promise<SettingsMCPServersResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
GET /api/settings/mcp-serversapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.listSettingsMCPServers();listSettingsProviders
List settings-backed providers
compozy.settings.listSettingsProviders() → Promise<SettingsProvidersResponse>
GET /api/settings/providersapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.listSettingsProviders();logoutSettingsMCPAuth
Log out one scoped MCP server
compozy.settings.logoutSettingsMCPAuth({ path, query }) → Promise<SettingsMCPAuthStatusPayload>
Options
- namestringpathrequired
- Configured MCP server name
- scope"user" | "profile" | "workspace"queryrequired
- Exact MCP settings scope
- workspace_idstringquery
- Required when scope is workspace
- profilestringquery
- Required when scope is profile
- ownerstringquery
- Definition owner: manual or extension:<name>; omitted owner selects manual
POST /api/settings/mcp-servers/{name}/auth/logoutapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.logoutSettingsMCPAuth({ path: { "name": "name" }, query: { "scope": "user" } });putSettingsHook
Create or replace one settings-backed hook declaration
compozy.settings.putSettingsHook({ path, query, body }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- Hook name
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
Request bodyPutSettingsHookRequest
PUT /api/settings/hooks/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.putSettingsHook({ path: { "name": "name" }, body: { /* request fields */ } });putSettingsMCPServer
Replace a manual MCP server or its extension override
compozy.settings.putSettingsMCPServer({ path, query, body }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- MCP server name
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
- ownerstringquery
- Select manual or extension:<name>; omitted owner selects manual servers only
- target"auto" | "config" | "sidecar"query
- Select the persistence target
Request bodyPutSettingsMCPServerRequest
PUT /api/settings/mcp-servers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.putSettingsMCPServer({ path: { "name": "name" }, body: { /* request fields */ } });putSettingsProvider
Create or replace one settings-backed provider overlay
compozy.settings.putSettingsProvider({ path, body }) → Promise<SettingsApplyResponse>
Options
- namestringpathrequired
- Provider name
Request bodyPutSettingsProviderRequest
PUT /api/settings/providers/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.putSettingsProvider({ path: { "name": "name" }, body: { /* request fields */ } });reloadSettings
Reconcile config.toml with the daemon active generation
compozy.settings.reloadSettings() → Promise<SettingsApplyResponse>
POST /api/settings/reloadapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.reloadSettings();setSettingsProviderEnabled
Enable or disable one provider
compozy.settings.setSettingsProviderEnabled({ path, body }) → Promise<SettingsProviderEnabledResponse>
Options
- namestringpathrequired
- Provider name
Request bodySetSettingsProviderEnabledRequest
PATCH /api/settings/providers/{name}/enabledapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.setSettingsProviderEnabled({ path: { "name": "name" }, body: { /* request fields */ } });streamSettingsObservabilityLogTail
Stream daemon log output for the observability settings screen
compozy.events("streamSettingsObservabilityLogTail", {}) → AsyncIterable<StreamEvent<SseFrame<"streamSettingsObservabilityLogTail">>>
GET /api/settings/observability/log-tailapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamSettingsObservabilityLogTail", {})) { console.log(frame);}triggerSettingsRestart
Trigger a daemon restart using the persisted relaunch helper flow
compozy.settings.triggerSettingsRestart() → Promise<RestartActionResponse>
POST /api/settings/actions/restartapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.triggerSettingsRestart();updateSettingsAttention
Update the operator attention settings section
compozy.settings.updateSettingsAttention({ query, body }) → Promise<SettingsApplyResponse>
Options
- scope"user" | "profile"query
- Select user or profile attention mutes
- profilestringquery
- Select the profile whose workspace mutes are returned
Request bodyUpdateSettingsAttentionRequest
PATCH /api/settings/attentionapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsAttention({ body: { /* request fields */ } });updateSettingsAutomation
Update the automation settings section
compozy.settings.updateSettingsAutomation({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsAutomationRequest
PATCH /api/settings/automationapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsAutomation({ body: { /* request fields */ } });updateSettingsCmdPalette
Update command-palette settings
compozy.settings.updateSettingsCmdPalette({ query, body }) → Promise<SettingsCmdPaletteResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
Request bodyUpdateSettingsCmdPaletteRequest
PATCH /api/settings/cmd-paletteapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsCmdPalette({ body: { /* request fields */ } });updateSettingsGeneral
Update the general settings section
compozy.settings.updateSettingsGeneral({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsGeneralRequest
PATCH /api/settings/generalapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsGeneral({ body: { /* request fields */ } });updateSettingsHooksExtensions
Update the hooks and extensions settings section
compozy.settings.updateSettingsHooksExtensions({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsHooksExtensionsRequest
PATCH /api/settings/hooks-extensionsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsHooksExtensions({ body: { /* request fields */ } });updateSettingsMarketplace
Apply global marketplace catalog URL, TTL, and timeout
compozy.settings.updateSettingsMarketplace({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsMarketplaceRequest
PATCH /api/settings/marketplaceapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsMarketplace({ body: { /* request fields */ } });updateSettingsObservability
Update the observability settings section
compozy.settings.updateSettingsObservability({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsObservabilityRequest
PATCH /api/settings/observabilityapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsObservability({ body: { /* request fields */ } });updateSettingsPersona
Update profile-layerable persona defaults
compozy.settings.updateSettingsPersona({ query, body }) → Promise<SettingsApplyResponse>
Options
- scope"user" | "profile" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace context
- profilestringquery
- Select the profile layer
Request bodyUpdateSettingsPersonaRequest
PATCH /api/settings/personaapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsPersona({ body: { /* request fields */ } });updateSettingsProviderUsage
Update the provider usage settings section
compozy.settings.updateSettingsProviderUsage({ query, body }) → Promise<SettingsApplyResponse>
Options
- collection_profilestringquery
- Collection profile name or ID for local Keychain consent; independent of user config scope; defaults to default
Request bodySettingsProviderUsageUpdateRequest
PATCH /api/settings/provider-usageapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsProviderUsage({ body: { /* request fields */ } });updateSettingsRoles
Update the background-role routing settings section
compozy.settings.updateSettingsRoles({ body }) → Promise<SettingsApplyResponse>
Request bodyUpdateSettingsRolesRequest
PATCH /api/settings/rolesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsRoles({ body: { /* request fields */ } });updateSettingsShell
Update the operator shell settings section
compozy.settings.updateSettingsShell({ body }) → Promise<SettingsShellMutationResponse>
Request bodyUpdateSettingsShellRequest
PATCH /api/settings/shellapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsShell({ body: { /* request fields */ } });updateSettingsSkills
Update the skills settings section
compozy.settings.updateSettingsSkills({ query, body }) → Promise<SettingsSkillsMutationResponse>
Options
- scope"user" | "profile" | "workspace" | "agent"query
- Select the settings scope
- workspace_idstringquery
- Workspace id for workspace or agent resolution context
- profilestringquery
- Profile name when scope=profile
- agent_namestringquery
- Agent name when scope=agent
Request bodyUpdateSettingsSkillsRequest
PATCH /api/settings/skillsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsSkills({ body: { /* request fields */ } });updateSettingsWindowManager
Update the window-manager settings section
compozy.settings.updateSettingsWindowManager({ query, body }) → Promise<SettingsWindowManagerMutationResponse>
Options
- scope"user" | "workspace"query
- Select the settings scope
- workspace_idstringquery
- Select the workspace id for workspace scope
- client_idstringquery
- Select the shell attachment for shortcut statuses
- client_profilestringquery
- Select the shell profile without changing settings scope
Request bodyUpdateSettingsWindowManagerRequest
PATCH /api/settings/window-managerapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.settings.updateSettingsWindowManager({ body: { /* request fields */ } });