TsgcHTTP_API_OpenAI › Methods › DeleteMessage

DeleteMessage Method

Deletes a specific message from a Thread

Syntax

function DeleteMessage(const aThreadId, aMessageId: string) : TsgcOpenAIClass_Response_Delete_Status;

Parameters

Name	Type	Description
aThreadId	const string	The identifier of the Thread that owns the message.
aMessageId	const string	The identifier of the message to delete.

Return Value

Deletion confirmation with the message id and a boolean Deleted flag (TsgcOpenAIClass_Response_Delete_Status)

Remarks

Calls DELETE /v1/threads/{thread_id}/messages/{message_id} to remove a single message from a Thread. The rest of the conversation history is preserved. The operation cannot be undone.

Example

begin
  if oAPI.DeleteMessage('thread_abc123', 'msg_abc123').Deleted then
    ShowMessage('Message removed');
end;

Back to Methods