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.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

sessionId
string<uuid>
required

Session id (UUID) as returned by managedAgentsStartSession or managedAgentsListSessions.

Body

application/json

Optional compatibility stop reason for pausing a session. Omit the body for ordinary Stop. This operation never supplies a replacement instruction; use managedAgentsSendSessionEvents with interrupt=true for Interrupt & send.

message
string

Optional stop reason retained for compatibility. It is recorded as a stop notice; it does not supply a replacement instruction or resume queued input.

Response

Response body of POST /managed-agents/v1/sessions/{sessionId}/interrupt. An interrupt is a cooperative control, not a session cancellation: the session stays alive and keeps accepting events. Work stays paused until Send or POST /managed-agents/v1/sessions/{sessionId}/resume. Use cancel for permanent cancellation and compute teardown.

Response body of POST /managed-agents/v1/sessions/{sessionId}/interrupt. An interrupt is a cooperative control, not a session cancellation: the session stays alive and keeps accepting events. Work stays paused until Send or POST /managed-agents/v1/sessions/{sessionId}/resume. Use cancel for permanent cancellation and compute teardown.

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 because the run ended as the request arrived. An already idle session is paused too; queued input is preserved until an explicit Send or Resume.