Skip to main content
POST
Interrupt a running session

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

session_id
string<uuid>
required

Session id (UUID) as returned by startSession or listSessions.

Body

application/json

Request body for interrupting a running session, optionally injecting a message the agent sees at the interruption point.

message
string

Optional reason recorded when the running session reaches its cooperative stop checkpoint.

Response

Response body of POST /v1/sessions/{session_id}/interrupt. An interrupt is a cooperative control, not a session cancellation: the session stays alive and keeps accepting events. Use POST /v1/sessions/{session_id}/cancel to stop it.

Response body of POST /v1/sessions/{session_id}/interrupt. An interrupt is a cooperative control, not a session cancellation: the session stays alive and keeps accepting events. Use POST /v1/sessions/{session_id}/cancel to stop it.

interrupted
boolean
required

True when the interrupt reached the running session and its active work was told to stop. False means the request was accepted and the stop recorded, but nothing running was confirmed interrupted -- typically a session that had already finished.