Get runtime config

Retrieve the current session-scoped runtime config blob and effective view.

GET /session/{sessionID}/runtime-config

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

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

200

{
  "sessionID": "<string>",
  "runtimeConfig": {
    "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
    }
  },
  "effective": {
    "systemPrompt": {
      "mode": "default",
      "hasAppend": true,
      "preset": "<string>"
    },
    "settingSources": [
      "user"
    ],
    "tools": {
      "allowed": [
        "<string>"
      ],
      "disallowed": [
        "<string>"
      ]
    },
    "agents": {},
    "skills": [
      {
        "name": "<string>",
        "source": "runtime",
        "pluginName": "<string>"
      }
    ],
    "commands": [
      {
        "name": "<string>",
        "source": "runtime",
        "pluginName": "<string>"
      }
    ],
    "plugins": [
      {
        "name": "<string>",
        "source": "inline",
        "skillCount": 4503599627370495,
        "commandCount": 4503599627370495,
        "agentCount": 4503599627370495,
        "hookEventCount": 4503599627370495,
        "mcpServerCount": 4503599627370495,
        "diagnostics": [
          "<string>"
        ]
      }
    ],
    "model": {
      "providerID": "<string>",
      "modelID": "<string>"
    },
    "maxTurns": 123,
    "maxBudgetUsd": 123,
    "permissionMode": "default",
    "autoPermissionClassifierModel": {
      "providerID": "<string>",
      "modelID": "<string>"
    },
    "canUseTool": {
      "registered": true
    },
    "hooks": {},
    "appendSystemPrompt": {
      "length": 4503599627370495
    }
  }
}

Path Parameters

sessionID · string · required

Pattern: ^ses.*

Query Parameters

directory · string

workspace · string

Response

200

application/json

Runtime config

sessionID · string · required

Pattern: ^ses.*

runtimeConfig · object · required

Show child attributes

effective · object · required

Show child attributes