Cancel Chat (v1.0.0)

Cancel a chat

Command DELETE Chat

Overview

The Cancel Chat endpoint allows users to terminate an active chat session in the BookWorm platform. This endpoint accepts a chat’s unique identifier (GUID) and cancels the associated chat session if it exists. It’s designed to provide users with the ability to gracefully end chat interactions when needed.

The endpoint follows RESTful principles and returns a 204 No Content response upon successful cancellation, indicating that the request was processed successfully but no content needs to be returned.

Architecture

DELETE /api/v1/chats/{id:guid}/cancel

Cancels a chat session by its unique identifier.

Path Parameters

NameTypeDescription
idGUIDThe unique identifier of the chat to be cancelled

Example Usage

Terminal window
curl -X DELETE https://api.bookworm.com/api/v1/chats/{id}/cancel

Response

204 No Content

Returns a 204 No Content response if the chat is successfully cancelled. This indicates that the request was processed successfully but there is no content to return.