API ReferenceThreads

Stop Thread Execution

Beta
Stop a running thread execution. This will stop the thread if it is currently running and mark it as cancelled.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

thread_idstringRequired
thread_idstringRequired
The unique thread ID to stop

Response

Thread cancelled successfully
messagestring
Status message about the cancellation
statusstring

New status of the thread (always ‘cancelled’)

stopped_atstring
ISO timestamp when thread was cancelled
thread_idstring
The thread ID that was cancelled

Errors