Cancel Thread Task

Cancel the currently running task in a thread.

This endpoint cancels any active task associated with the specified thread. This is useful for stopping long-running operations. The endpoint returns the success status of the cancellation operation.

This endpoint will append a “User cancelled message” message to whatever has been streamed so far.

Authentication

AuthorizationBearer
OAuth2 access token obtained via token exchange.

Path parameters

thread_idstringRequired

Response

Successful Response
successboolean or nullDefaults to true

Errors