Cancel the active agent turn

View as Markdown
Cancel the active turn in a conversation.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

conversationIdstringRequired
Unique conversation identifier generated by BCTRL.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response

OK
cancelledtrue
conversationIdstring
Unique conversation identifier generated by BCTRL.
turnIdstring or null

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error