sessions module route (requires sessions:template:read)

POST

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

curl --request POST \
  --url https://example.com/v1/m/sessions/templates/example/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target": { "allowed_tools": [ "example" ], "custom_instructions": "example", "effort": "example", "max_session_duration_minutes": 1, "model": "example", "permission_mode": "example", "record_io": true, "transport": "example", "workspace_ref": "example" } }'

• this engine

Resolves one session template into the run parameters it would produce, without starting a run.

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

Media type application/json

Any of:

object

object

target

Any of:

object

object

allowed_tools

Any of:

Array

Array

null

null

custom_instructions

Any of:

string

Proposed custom instructions.

string

null

null

effort

Any of:

string

Proposed launch effort.

string

null

null

max_session_duration_minutes

Any of:

integer

integer format: int64

null

null

model

Any of:

string

Proposed launch model.

string

null

null

permission_mode

Any of:

string

Proposed launch permission mode.

string

null

null

record_io

Any of:

boolean

boolean

null

null

transport

Any of:

string

Preview transport; unenforceable template terms are reported rather than silently dropped.

string

null

null

workspace_ref

Any of:

string

Proposed workspace reference.

string

null

null

null

null

null

null

Example ^generated

{
  "target": {
    "allowed_tools": [
      "example"
    ],
    "custom_instructions": "example",
    "effort": "example",
    "max_session_duration_minutes": 1,
    "model": "example",
    "permission_mode": "example",
    "record_io": true,
    "transport": "example",
    "workspace_ref": "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

{}