Skip to main content
POST
Stop an AI Assistant chat turn

Authorizations

X-API-Key
string
header
required

Path Parameters

conversation_id
string<uuid>
required
sequence
integer
required

Response

Successful Response

A Stop was asked for. Whether it lands is the stream's to say.

The flag is cooperative and best effort: the turn reads it before its model call and while the model writes, and a turn that has already landed is not affected. The stream reports the outcome as a result whose reply carries failed and reads Stopped by you. Echoes the turn the Stop was addressed to, as the turn frame named it.

conversation_id
string<uuid>
required
user_message_sequence
integer
required