Patch runtime config

Merge a partial runtime config into the current session-scoped blob.

PATCH /session/{sessionID}/runtime-config

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.session.runtimeConfig.patch({
  ...
})

200

{
  "systemPrompt": "<string>",
  "appendSystemPrompt": "<string>",
  "model": {
    "providerID": "<string>",
    "modelID": "<string>"
  },
  "effort": "low",
  "thinkingConfig": {
    "type": "adaptive"
  },
  "compaction": {
    "auto": true,
    "includeFiles": true
  },
  "includeEnvironment": true,
  "maxTurns": 123,
  "maxBudgetUsd": 123,
  "permissionMode": "default",
  "canUseTool": true,
  "autoPermissionClassifierModel": {
    "providerID": "<string>",
    "modelID": "<string>"
  },
  "allowedTools": [
    "<string>"
  ],
  "disallowedTools": [
    "<string>"
  ],
  "settingSources": [
    "user"
  ],
  "agents": {},
  "skills": [
    {
      "name": "<string>",
      "description": "<string>",
      "content": "<string>",
      "baseDir": "<string>",
      "allowedTools": [
        "<string>"
      ],
      "model": "<string>",
      "disableModelInvocation": true
    }
  ],
  "commands": [
    {
      "name": "<string>",
      "template": "<string>",
      "description": "<string>",
      "agent": "<string>",
      "model": "<string>",
      "subtask": true,
      "allowedTools": [
        "<string>"
      ],
      "disallowedTools": [
        "<string>"
      ]
    }
  ],
  "plugins": [
    {
      "type": "inline",
      "name": "<string>",
      "description": "<string>",
      "version": "<string>",
      "skills": [
        {
          "name": "<string>",
          "description": "<string>",
          "content": "<string>",
          "baseDir": "<string>",
          "allowedTools": [
            "<string>"
          ],
          "model": "<string>",
          "disableModelInvocation": true
        }
      ],
      "commands": [
        {
          "name": "<string>",
          "template": "<string>",
          "description": "<string>",
          "agent": "<string>",
          "model": "<string>",
          "subtask": true,
          "allowedTools": [
            "<string>"
          ],
          "disallowedTools": [
            "<string>"
          ]
        }
      ],
      "agents": {},
      "hooks": {},
      "mcpServers": [
        {
          "name": "<string>",
          "type": "remote",
          "url": "<string>",
          "enabled": true,
          "headers": {},
          "oauth": false,
          "timeout": 123,
          "transport": "http",
          "ownership": "sdk"
        }
      ]
    }
  ],
  "hooks": {},
  "sdkMcpServers": [
    {
      "name": "<string>",
      "type": "remote",
      "url": "<string>",
      "enabled": true,
      "headers": {},
      "oauth": false,
      "timeout": 123,
      "transport": "http",
      "ownership": "sdk"
    }
  ],
  "enableToolSearch": true,
  "enableFileCheckpointing": true,
  "outputFormat": {
    "type": "json_schema",
    "schema": {},
    "retryCount": 2
  },
  "backgroundTaskPolicy": {
    "mode": "foreground"
  },
  "checkpointing": {
    "enabled": true,
    "beforeTools": true,
    "beforeCompaction": true
  }
}

Path Parameters

sessionID · string · required

Pattern: ^ses.*

Query Parameters

directory · string

workspace · string

Body

application/json

systemPrompt · string object

appendSystemPrompt · string

model · object

Show child attributes

effort · enum<string>

Available options: low, medium, high, max

thinkingConfig · object

Option 1

Option 2

Option 3

Show child attributes

compaction · object

Show child attributes

includeEnvironment · boolean

maxTurns · integer

Required range: x <= 9007199254740991

maxBudgetUsd · number

permissionMode · enum<string>

Available options: default, acceptEdits, dontAsk, plan, bypassPermissions, auto

canUseTool · boolean

autoPermissionClassifierModel · object

Show child attributes

allowedTools · string[]

disallowedTools · string[]

settingSources · enum<string>[]

Available options: user, project, local

agents · object

Show child attributes

skills · object[]

Show child attributes

commands · object[]

Show child attributes

plugins · object[]

Option 1

Option 2

Show child attributes

hooks · object

Show child attributes

sdkMcpServers · object[]

Option 1

Option 2

Option 3

Show child attributes

enableToolSearch · Option 1 · boolean Option 2 · string Option 3 · string Option 4 · string

enableFileCheckpointing · boolean

outputFormat · object

Show child attributes

backgroundTaskPolicy · object

Show child attributes

checkpointing · object

Show child attributes

Response

200

application/json

Updated runtime config

systemPrompt · string object

appendSystemPrompt · string

model · object

Show child attributes

effort · enum<string>

Available options: low, medium, high, max

thinkingConfig · object

Option 1

Option 2

Option 3

Show child attributes

compaction · object

Show child attributes

includeEnvironment · boolean

maxTurns · integer

Required range: x <= 9007199254740991

maxBudgetUsd · number

permissionMode · enum<string>

Available options: default, acceptEdits, dontAsk, plan, bypassPermissions, auto

canUseTool · boolean

autoPermissionClassifierModel · object

Show child attributes

allowedTools · string[]

disallowedTools · string[]

settingSources · enum<string>[]

Available options: user, project, local

agents · object

Show child attributes

skills · object[]

Show child attributes

commands · object[]

Show child attributes

plugins · object[]

Option 1

Option 2

Show child attributes

hooks · object

Show child attributes

sdkMcpServers · object[]

Option 1

Option 2

Option 3

Show child attributes

enableToolSearch · Option 1 · boolean Option 2 · string Option 3 · string Option 4 · string

enableFileCheckpointing · boolean

outputFormat · object

Show child attributes

backgroundTaskPolicy · object

Show child attributes

checkpointing · object

Show child attributes