Skip to content

Delete chat completion

chat.completions.delete(completion_id) -> ChatCompletionDeleted { id, deleted, object }
DELETE/chat/completions/{completion_id}

Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

ParametersExpand Collapse
completion_id: String
ReturnsExpand Collapse
class ChatCompletionDeleted { id, deleted, object }
id: String

The ID of the chat completion that was deleted.

deleted: bool

Whether the chat completion was deleted.

object: :"chat.completion.deleted"

The type of object being deleted.

Delete chat completion

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

chat_completion_deleted = openai.chat.completions.delete("completion_id")

puts(chat_completion_deleted)
{
  "id": "id",
  "deleted": true,
  "object": "chat.completion.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "chat.completion.deleted"
}