Skip to content
Developer Preview

TurnInterruptParams

turn/interrupt params: the “user pressed stop” gesture, on the runtime’s priority lane.

  • commandId
  • retract
  • sessionId
  • turnId
Source

schema/msp/experimental/msp.schema.json#/types/TurnInterruptParams

{
"description": "`turn/interrupt` params: the \"user pressed stop\" gesture, on\nthe runtime's priority lane.",
"properties": {
"commandId": {
"description": "The idempotency handle (UUIDv7).",
"type": "string"
},
"retract": {
"description": "Pair a retract intent with the interrupt: if the turn is cancelled\nbefore any assistant output committed, the submission is durably\nretracted (view event `turn/retracted`) so the client may restore the\nprompt text. A rejected retract does not undo the interrupt. Default\n`false`.",
"type": "boolean"
},
"sessionId": {
"description": "The target session.",
"type": "string"
},
"turnId": {
"description": "The exact turn to interrupt. Omit to target the session's current\nforeground turn, resolved at admission; prefer passing the explicit id\nwhen you have one.",
"type": "string"
}
},
"required": [
"commandId",
"sessionId"
],
"type": "object"
}