sessions

Update Session

Changed on
put/sessions/{session_id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/sessions/{session_id}
  • Auth
    API key in header Authorization

Path parameters

session_idstring uuid required

Request body

situationstring nullable
system_templatestring nullable
render_templatesboolean
token_budgetinteger nullable
context_overflow'truncate' | 'adaptive' nullable
auto_run_toolsboolean
forward_tool_callsboolean
metadataobject nullable

Response

Successful Response

situationstring nullable
system_templatestring nullable
summarystring nullable
render_templatesboolean
token_budgetinteger nullable
context_overflow'truncate' | 'adaptive' nullable
auto_run_toolsboolean
forward_tool_callsboolean
idstring uuid required
metadataobject nullable
created_atstring date-time required
updated_atstring date-time required
kindstring nullable

Changes

  • a5693caa5db1Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 088c2ebb8988Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value changed from 0 to 0.5

    • info

      the request property default value changed from 0 to 0.5

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from 0 to 0.5 for the status

    • info

      the response's property default value changed from 0 to 0.5 for the status