Run shell command

Execute a shell command within the session context and return the AI’s response.

POST /session/{sessionID}/shell

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.session.shell({
  ...
})

200

{
  "info": {
    "id": "<string>",
    "sessionID": "<string>",
    "role": "user",
    "time": {
      "created": 123
    },
    "agent": "<string>",
    "model": {
      "providerID": "<string>",
      "modelID": "<string>",
      "variant": "<string>"
    },
    "parentMessageID": "<string>",
    "format": {
      "type": "text"
    },
    "summary": {
      "diffs": [
        {
          "file": "<string>",
          "patch": "<string>",
          "additions": 123,
          "deletions": 123,
          "status": "added"
        }
      ],
      "title": "<string>",
      "body": "<string>"
    },
    "system": "<string>",
    "tools": {}
  },
  "parts": [
    {
      "id": "<string>",
      "sessionID": "<string>",
      "messageID": "<string>",
      "type": "text",
      "text": "<string>",
      "synthetic": true,
      "ignored": true,
      "time": {
        "start": 123,
        "end": 123
      },
      "metadata": {}
    }
  ]
}

Path Parameters

sessionID · string · required

Pattern: ^ses.*

Query Parameters

directory · string

workspace · string

Body

application/json

agent · string · required

command · string · required

messageID · string

Pattern: ^msg.*

model · object

Show child attributes

Response

200

application/json

Created message

info · object · required

Option 1

Option 2

Show child attributes

parts · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Show child attributes