Update configuration

Update Cognitio configuration settings and preferences.

PATCH /config

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.config.update({
  ...
})

200

{
  "$schema": "<string>",
  "logLevel": "DEBUG",
  "server": {
    "port": 123,
    "hostname": "<string>",
    "mdns": true,
    "mdnsDomain": "<string>",
    "cors": [
      "<string>"
    ]
  },
  "command": {},
  "skills": {
    "paths": [
      "<string>"
    ],
    "urls": [
      "<string>"
    ]
  },
  "watcher": {
    "ignore": [
      "<string>"
    ]
  },
  "snapshot": true,
  "plugin": [
    "<string>"
  ],
  "share": "manual",
  "autoshare": true,
  "autoupdate": true,
  "disabled_providers": [
    "<string>"
  ],
  "enabled_providers": [
    "<string>"
  ],
  "model": "<string>",
  "small_model": "<string>",
  "default_agent": "<string>",
  "username": "<string>",
  "mode": {
    "build": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "plan": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    }
  },
  "agent": {
    "plan": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "build": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "general": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "explore": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "title": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "summary": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    },
    "compaction": {
      "model": "<string>",
      "variant": "<string>",
      "temperature": 123,
      "top_p": 123,
      "prompt": "<string>",
      "tools": {},
      "disable": true,
      "description": "<string>",
      "mode": "subagent",
      "hidden": true,
      "options": {},
      "color": "<string>",
      "steps": 123,
      "maxSteps": 123,
      "permission": {
        "__originalKeys": [
          "<string>"
        ],
        "read": "ask",
        "edit": "ask",
        "glob": "ask",
        "grep": "ask",
        "list": "ask",
        "bash": "ask",
        "task": "ask",
        "external_directory": "ask",
        "todowrite": "ask",
        "question": "ask",
        "webfetch": "ask",
        "websearch": "ask",
        "codesearch": "ask",
        "lsp": "ask",
        "doom_loop": "ask",
        "skill": "ask"
      }
    }
  },
  "provider": {},
  "mcp": {},
  "formatter": true,
  "lsp": true,
  "instructions": [
    "<string>"
  ],
  "layout": "auto",
  "permission": {
    "__originalKeys": [
      "<string>"
    ],
    "read": "ask",
    "edit": "ask",
    "glob": "ask",
    "grep": "ask",
    "list": "ask",
    "bash": "ask",
    "task": "ask",
    "external_directory": "ask",
    "todowrite": "ask",
    "question": "ask",
    "webfetch": "ask",
    "websearch": "ask",
    "codesearch": "ask",
    "lsp": "ask",
    "doom_loop": "ask",
    "skill": "ask"
  },
  "tools": {},
  "enterprise": {
    "url": "<string>"
  },
  "compaction": {
    "auto": true,
    "prune": true,
    "tail_turns": 4503599627370495,
    "preserve_recent_tokens": 4503599627370495,
    "reserved": 4503599627370495
  },
  "experimental": {
    "disable_paste_summary": true,
    "batch_tool": true,
    "openTelemetry": true,
    "openTelemetryRecordInputs": true,
    "openTelemetryRecordOutputs": true,
    "primary_tools": [
      "<string>"
    ],
    "continue_loop_on_deny": true,
    "mcp_timeout": 123
  }
}

Query Parameters

directory · string

workspace · string

Body

application/json

$schema · string

JSON schema reference for configuration validation

logLevel · enum<string>

Log level

Available options: DEBUG, INFO, WARN, ERROR

server · object

Server configuration for cognitio serve and web commands

Show child attributes

command · object

Command configuration

Show child attributes

skills · object

Additional skill folder paths

Show child attributes

watcher · object

Show child attributes

snapshot · boolean

Enable or disable snapshot tracking. When false, filesystem snapshots are not recorded and undoing or reverting will not undo/redo file changes. Defaults to true.

plugin · (string | object)[]

share · enum<string>

Control sharing behavior:'manual' allows manual sharing via commands, 'auto' enables automatic sharing, 'disabled' disables all sharing

Available options: manual, auto, disabled

autoshare · boolean

@deprecated Use 'share' field instead. Share newly created sessions automatically

autoupdate · boolean string

Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications

disabled_providers · string[]

Disable providers that are loaded automatically

enabled_providers · string[]

When set, ONLY these providers will be enabled. All other providers will be ignored

model · string

Model to use in the format of provider/model, eg anthropic/claude-2

small_model · string

Small model to use for tasks like title generation in the format of provider/model

default_agent · string

Default agent to use when none is specified. Must be a primary agent. Falls back to 'build' if not set or if the specified agent is invalid.

username · string

Custom username to display in conversations instead of system username

mode · object

@deprecated Use agent field instead.

Show child attributes

agent · object

Agent configuration

Show child attributes

provider · object

Custom provider configurations and model overrides

Show child attributes

mcp · object

MCP (Model Context Protocol) server configurations

Show child attributes

formatter · boolean object

lsp · boolean object

instructions · string[]

Additional instruction files or patterns to include

layout · enum<string>

@deprecated Always uses stretch layout.

Available options: auto, stretch

permission · object enum<string>

Show child attributes

tools · object

Show child attributes

enterprise · object

Show child attributes

compaction · object

Show child attributes

experimental · object

Show child attributes

Response

200

application/json

Successfully updated config

$schema · string

JSON schema reference for configuration validation

logLevel · enum<string>

Log level

Available options: DEBUG, INFO, WARN, ERROR

server · object

Server configuration for cognitio serve and web commands

Show child attributes

command · object

Command configuration

Show child attributes

skills · object

Additional skill folder paths

Show child attributes

watcher · object

Show child attributes

snapshot · boolean

Enable or disable snapshot tracking. When false, filesystem snapshots are not recorded and undoing or reverting will not undo/redo file changes. Defaults to true.

plugin · (string | object)[]

share · enum<string>

Control sharing behavior:'manual' allows manual sharing via commands, 'auto' enables automatic sharing, 'disabled' disables all sharing

Available options: manual, auto, disabled

autoshare · boolean

@deprecated Use 'share' field instead. Share newly created sessions automatically

autoupdate · boolean string

Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications

disabled_providers · string[]

Disable providers that are loaded automatically

enabled_providers · string[]

When set, ONLY these providers will be enabled. All other providers will be ignored

model · string

Model to use in the format of provider/model, eg anthropic/claude-2

small_model · string

Small model to use for tasks like title generation in the format of provider/model

default_agent · string

Default agent to use when none is specified. Must be a primary agent. Falls back to 'build' if not set or if the specified agent is invalid.

username · string

Custom username to display in conversations instead of system username

mode · object

@deprecated Use agent field instead.

Show child attributes

agent · object

Agent configuration

Show child attributes

provider · object

Custom provider configurations and model overrides

Show child attributes

mcp · object

MCP (Model Context Protocol) server configurations

Show child attributes

formatter · boolean object

lsp · boolean object

instructions · string[]

Additional instruction files or patterns to include

layout · enum<string>

@deprecated Always uses stretch layout.

Available options: auto, stretch

permission · object enum<string>

Show child attributes

tools · object

Show child attributes

enterprise · object

Show child attributes

compaction · object

Show child attributes

experimental · object

Show child attributes