---
title: "Patch Session"
method: PATCH
path: "/sessions/{session_id}"
tags: ["sessions"]
---

# Patch Session

`PATCH /sessions/{session_id}`

## Path parameters

- `session_id` string, uuid, required

## Request body

- PatchSessionRequest — Payload for patching a session
  - `situation` string, nullable
  - `system_template` string, nullable
  - `render_templates` boolean
  - `token_budget` integer, nullable
  - `context_overflow` 'truncate' | 'adaptive', nullable
  - `auto_run_tools` boolean
  - `forward_tool_calls` boolean
  - `recall_options` union
    - VectorDocSearchUpdate
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'vector'
      - `confidence` number
      - `mmr_strength` number
    - TextOnlyDocSearchUpdate
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'text'
      - `trigram_similarity_threshold` number
    - HybridDocSearchUpdate
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'hybrid'
      - `confidence` number
      - `alpha` number
      - `mmr_strength` number
      - `trigram_similarity_threshold` number
      - `k_multiplier` integer
  - `metadata` object, nullable

## Response `200`

Successful Response

- Session
  - `situation` string, nullable
  - `system_template` string, nullable
  - `summary` string, nullable
  - `render_templates` boolean
  - `token_budget` integer, nullable
  - `context_overflow` 'truncate' | 'adaptive', nullable
  - `auto_run_tools` boolean
  - `forward_tool_calls` boolean
  - `recall_options` union
    - VectorDocSearch
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'vector'
      - `confidence` number
      - `mmr_strength` number
    - TextOnlyDocSearch
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'text'
      - `trigram_similarity_threshold` number
    - HybridDocSearch
      - `limit` integer
      - `lang` string
      - `metadata_filter` object
      - `num_search_messages` integer
      - `max_query_length` integer
      - `mode` 'hybrid'
      - `confidence` number
      - `alpha` number
      - `mmr_strength` number
      - `trigram_similarity_threshold` number
      - `k_multiplier` integer
  - `id` string, uuid, required
  - `metadata` object, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `kind` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2025-05-12** `088c2ebb8988` — 10 info
  - added the new optional request property `recall_options/anyOf[subschema #2: TextOnlyDocSearchUpdate]/trigram_similarity_threshold`
  - added the new optional request property `recall_options/anyOf[subschema #3: HybridDocSearchUpdate]/k_multiplier`
  - added the new optional request property `recall_options/anyOf[subschema #3: HybridDocSearchUpdate]/trigram_similarity_threshold`
  - the `confidence` request property default value changed from `0` to `0.5`
  - …6 more
- **2025-03-03** `1f91c7da5438` — 1 breaking, 5 info
  - the `mode` request property const value `hybrid` was added
  - added `#/components/schemas/VectorDocSearchUpdate, #/components/schemas/TextOnlyDocSearchUpdate` to the `recall_options` request property `anyOf` list
  - the `alpha` request property default value changed from `0.75` to `0.5`
  - added `#/components/schemas/VectorDocSearch, #/components/schemas/TextOnlyDocSearch` to the `recall_options` response property `anyOf` list for the response status `200`
  - …2 more
- **2025-03-01** `5760ee26a52a` — 1 breaking, 1 info
  - removed `#/components/schemas/VectorDocSearchUpdate, #/components/schemas/TextOnlyDocSearchUpdate` from the `recall_options` request property `anyOf` list
  - removed `#/components/schemas/VectorDocSearch, #/components/schemas/TextOnlyDocSearch` from the `recall_options` response property `anyOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/julep-ai/apis/julep-agents-api/changes/sessions/:session_id/patch.md)

---

[API](https://skmtc.dev/julep-ai/apis/julep-agents-api.md) · [All operations](https://skmtc.dev/julep-ai/apis/julep-agents-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/julep-ai/julep-agents-api/revisions/512e2c8aa9ce/schema)