ruby/resources/conversations/methods/delete/index.md +0 −45 deleted
File Deleted View Diff
1## Delete a conversation
2
3`conversations.delete(conversation_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: String`
12
13### Returns
14
15- `class ConversationDeletedResource`
16
17 - `id: String`
18
19 - `deleted: bool`
20
21 - `object: :"conversation.deleted"`
22
23 - `:"conversation.deleted"`
24
25### Example
26
27```ruby
28require "openai"
29
30openai = OpenAI::Client.new(api_key: "My API Key")
31
32conversation_deleted_resource = openai.conversations.delete("conv_123")
33
34puts(conversation_deleted_resource)
35```
36
37#### Response
38
39```json
40{
41 "id": "id",
42 "deleted": true,
43 "object": "conversation.deleted"
44}
45```