python/resources/conversations/methods/delete/index.md +0 −68 deleted
File Deleted View Diff
1## Delete a conversation
2
3`conversations.delete(strconversation_id) -> ConversationDeletedResource`
4
5**delete** `/conversations/{conversation_id}`
6
7Delete a conversation. Items in the conversation will not be deleted.
8
9### Parameters
10
11- `conversation_id: str`
12
13### Returns
14
15- `class ConversationDeletedResource: …`
16
17 - `id: str`
18
19 - `deleted: bool`
20
21 - `object: Literal["conversation.deleted"]`
22
23 - `"conversation.deleted"`
24
25### Example
26
27```python
28import os
29from openai import OpenAI
30
31client = OpenAI(
32 api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
33)
34conversation_deleted_resource = client.conversations.delete(
35 "conv_123",
36)
37print(conversation_deleted_resource.id)
38```
39
40#### Response
41
42```json
43{
44 "id": "id",
45 "deleted": true,
46 "object": "conversation.deleted"
47}
48```
49
50### Example
51
52```python
53from openai import OpenAI
54client = OpenAI()
55
56deleted = client.conversations.delete("conv_123")
57print(deleted)
58```
59
60#### Response
61
62```json
63{
64 "id": "conv_123",
65 "object": "conversation.deleted",
66 "deleted": true
67}
68```