threads

Cancel thread advancement

Sets a thread's generation stage to CANCELLED

post/threads/{id}/cancel

Path parameters

idstring required
Example:thread_123456789

ID of the thread to cancel

Response

Thread cancelled successfully

metadataobject
projectIdstring required
generationStage'IDLE' | 'CHOOSING_COMPONENT' | 'FETCHING_CONTEXT' | 'HYDRATING_COMPONENT' | 'STREAMING_RESPONSE' | 'COMPLETE' | 'ERROR' | 'CANCELLED'
statusMessagestring
namestring
idstring required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this endpoint across all 3 revisions of this API.