Skip to main content
POST
Stop a preview that is being written

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required
preview_id
string<uuid>
required

Response

Successful Response

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

The request is cooperative and best effort: the preview reads it before each model call and while the model writes, and a preview that has already finished is not affected. The stream reports a Stop that landed as an error frame with reason stopped.

preview_id
string<uuid>
required