Threads, Assistants

Delete a message

DELETE /openai/v1/threads/{thread_id}/messages/{message_id}

Deletes a message by its identifier.

Parametry cesty

thread_id string vyžadováno

The ID of the thread to which this message belongs.

message_id string vyžadováno

The ID of the message to delete.

Odpovědi

The request has succeeded.

Text

Content-Type: application/json

id string vyžadováno

deleted boolean vyžadováno

object enum vyžadováno

thread.message.deleted

Žádost

curl -X DELETE https://api.openai.com/v1/threads/thread_abc123/messages/msg_abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Beta: assistants=v2"

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
message_deleted = client.beta.threads.messages.delete(
    message_id="message_id",
    thread_id="thread_id",
)
print(message_deleted.id)

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);
}

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const messageDeleted = await client.beta.threads.messages.delete('message_id', {
  thread_id: 'thread_id',
});

console.log(messageDeleted.id);

package main

import (
    "context"
    "fmt"

    "github.com/openai/openai-go"
    "github.com/openai/openai-go/option"
)

func main() {
    client := openai.NewClient(
        option.WithAPIKey("My API Key"),
    )
    messageDeleted, err := client.Beta.Threads.Messages.Delete(
        context.TODO(),
        "thread_id",
        "message_id",
    )
    if err != nil {
        panic(err.Error())
    }
    fmt.Printf("%+v
", messageDeleted.ID)
}

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.beta.threads.messages.MessageDeleteParams;
import com.openai.models.beta.threads.messages.MessageDeleted;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        MessageDeleteParams params = MessageDeleteParams.builder()
            .threadId("thread_id")
            .messageId("message_id")
            .build();
        MessageDeleted messageDeleted = client.beta().threads().messages().delete(params);
    }
}

require "openai"

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

message_deleted = openai.beta.threads.messages.delete("message_id", thread_id: "thread_id")

puts(message_deleted)

Response

{
  "id": "msg_abc123",
  "object": "thread.message.deleted",
  "deleted": true
}