sessions module route (requires sessions:template:write)

PUT

/v1/m/sessions/templates/{id}

curl --request PUT \
  --url https://example.com/v1/m/sessions/templates/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": { "connectors": [ "example" ], "hooks": { "post_session": [ { "command": "example", "timeout_ms": 1 } ], "post_tool": [ { "command": "example", "timeout_ms": 1 } ], "pre_session": [ { "command": "example", "timeout_ms": 1 } ], "pre_tool": [ { "command": "example", "timeout_ms": 1 } ] }, "policies": { "allowed_tools": [ "example" ], "dlp_mode": "example", "max_session_duration_minutes": 1, "record_io": true }, "settings": { "custom_instructions": "example", "effort": "example", "model": "example", "permission_mode": "example" } }, "description": "example", "name": "example" }'

• this engine

Replaces one session template; an unknown key in the body is refused rather than dropped, and a built-in template is refused.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

Any of:

object

object

body

Any of:

object

object

connectors

Any of:

Array

Array

null

null

hooks

Any of:

object

object

post_session

Any of:

Array

Array

Any of:

object

object

command

Any of:

string

Hook command; the template authoring handler stores it without semantic validation.

string

null

null

timeout_ms

Any of:

integer

integer

null

null

null

null

null

null

post_tool

Any of:

Array

Array

Any of:

object

object

command

Any of:

string

Hook command; the template authoring handler stores it without semantic validation.

string

null

null

timeout_ms

Any of:

integer

integer

null

null

null

null

null

null

pre_session

Any of:

Array

Array

Any of:

object

object

command

Any of:

string

Hook command; the template authoring handler stores it without semantic validation.

string

null

null

timeout_ms

Any of:

integer

integer

null

null

null

null

null

null

pre_tool

Any of:

Array

Array

Any of:

object

object

command

Any of:

string

Hook command; the template authoring handler stores it without semantic validation.

string

null

null

timeout_ms

Any of:

integer

integer

null

null

null

null

null

null

null

null

policies

Any of:

object

object

allowed_tools

Any of:

Array

Array

null

null

dlp_mode

Any of:

string

Validated when the template is reduced for preview or launch.

string

null

null

max_session_duration_minutes

Any of:

integer

integer

null

null

record_io

Any of:

boolean

boolean

null

null

null

null

settings

Any of:

object

object

custom_instructions

Any of:

string

Stored custom instructions.

string

null

null

effort

Any of:

string

Validated when the template is reduced for preview or launch.

string

null

null

model

Any of:

string

Stored template model selector.

string

null

null

permission_mode

Any of:

string

Validated when the template is reduced for preview or launch.

string

null

null

null

null

null

null

description

Any of:

string

An explicit string replaces the stored description; null/omission preserves it.

string

null

null

name

Any of:

string

An explicit string, including empty, replaces the stored name; null/omission preserves it.

string

null

null

null

null

Example ^generated

{
  "body": {
    "connectors": [
      "example"
    ],
    "hooks": {
      "post_session": [
        {
          "command": "example",
          "timeout_ms": 1
        }
      ],
      "post_tool": [
        {
          "command": "example",
          "timeout_ms": 1
        }
      ],
      "pre_session": [
        {
          "command": "example",
          "timeout_ms": 1
        }
      ],
      "pre_tool": [
        {
          "command": "example",
          "timeout_ms": 1
        }
      ]
    },
    "policies": {
      "allowed_tools": [
        "example"
      ],
      "dlp_mode": "example",
      "max_session_duration_minutes": 1,
      "record_io": true
    },
    "settings": {
      "custom_instructions": "example",
      "effort": "example",
      "model": "example",
      "permission_mode": "example"
    }
  },
  "description": "example",
  "name": "example"
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}