cli/resources/conversations/methods/delete/index.md +0 −41 deleted
File Deleted View Diff
1## Delete a conversation
2
3`$ openai conversations delete`
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: string`
12
13 The ID of the conversation to delete.
14
15### Returns
16
17- `conversation_deleted_resource: object { id, deleted, object }`
18
19 - `id: string`
20
21 - `deleted: boolean`
22
23 - `object: "conversation.deleted"`
24
25### Example
26
27```cli
28openai conversations delete \
29 --api-key 'My API Key' \
30 --conversation-id conv_123
31```
32
33#### Response
34
35```json
36{
37 "id": "id",
38 "deleted": true,
39 "object": "conversation.deleted"
40}
41```