Skip to main content
Requests cancellation of a durable turn and returns its current status with 202 Accepted.
Cancellation is cooperative. A 202 response confirms the request was accepted; it does not guarantee the producer has stopped. Poll Get Turn until status leaves in_progress.
string
required
Bearer token obtained from Authenticate.
string
required
Published agent UUID used to run the chat.
string
required
Member-owned chat UUID.
string
required
Durable turn UUID to cancel.
The request has no body and does not consume the shared turn-submission throttle.

Response

The response has the same shape as Get Turn:
string
required
Durable turn UUID.
string
required
Owning chat UUID.
string
required
Current public status: in_progress, completed, failed, or cancelled. It commonly remains in_progress in the immediate acknowledgement.
string
required
ISO 8601 acceptance timestamp.
string | null
required
Terminal timestamp when available.
integer
required
Highest durable event sequence represented by the snapshot.
string | null
required
Persisted partial assistant text through last_seq.
string | null
required
UUID of the persisted terminal assistant message, when one was written. A cancelled turn with persisted partial output can have a non-null value.
boolean
required
Current exact-replay availability.
boolean
required
Whether exact replay has degraded.
object | null
required
Safe public error for a failed turn, otherwise null.
Calling cancel on an already-terminal turn is idempotent: the server returns its unchanged terminal status. A completion racing with cancellation can therefore return completed rather than cancelled. The response fields depend on when cancellation is observed:
  • The immediate response to an accepted cancellation can still be in_progress, with partial content already visible but no result_message_id yet.
  • A turn cancelled before producing output can finish with both partial_content and result_message_id set to null.
  • A turn cancelled after producing partial output can finish with both partial_content and result_message_id set; the ID addresses the persisted partial assistant message.
  • If completion or failure wins the race, the endpoint returns that terminal status and its corresponding result_message_id.