Skip to content
Primary navigation

Delete message

Deprecated
client.beta.threads.messages.delete(stringmessageID, MessageDeleteParams { thread_id } params, RequestOptionsoptions?): MessageDeleted { id, deleted, object }
DELETE/threads/{thread_id}/messages/{message_id}

Deletes a message.

ParametersExpand Collapse
messageID: string
params: MessageDeleteParams { thread_id }
thread_id: string

The ID of the thread to which this message belongs.

ReturnsExpand Collapse
MessageDeleted { id, deleted, object }
id: string
deleted: boolean
object: "thread.message.deleted"

Delete message

import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const deletedMessage = await openai.beta.threads.messages.delete(
    "msg_abc123",
    { thread_id: "thread_abc123" }
  );

  console.log(deletedMessage);
}
{
  "id": "msg_abc123",
  "object": "thread.message.deleted",
  "deleted": true
}
Returns Examples
{
  "id": "msg_abc123",
  "object": "thread.message.deleted",
  "deleted": true
}