Skip to main content
POST

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

id
string
required

Body

application/json
clearQueue
boolean

Also clear queued steering/follow-up messages so the abort leaves the agent fully idle. Cleared texts are returned in the response.data.clearedQueue field of the response body. Without it, messages still queued when the abort settles are auto-continued as a new run. Runtimes older than the Linc release that supports this flag ignore it: the abort still happens but the queue is left untouched.

Response

Cancel accepted. Includes the native Pi RPC abort response as response (with response.data.clearedQueue when clearQueue was requested and the runtime supports it).