ruby/resources/videos/methods/delete/index.md +0 −65 deleted
File Deleted View Diff
1## Delete video
2
3`videos.delete(video_id) -> VideoDeleteResponse`
4
5**delete** `/videos/{video_id}`
6
7Permanently delete a completed or failed video and its stored assets.
8
9### Parameters
10
11- `video_id: String`
12
13### Returns
14
15- `class VideoDeleteResponse`
16
17 Confirmation payload returned after deleting a video.
18
19 - `id: String`
20
21 Identifier of the deleted video.
22
23 - `deleted: bool`
24
25 Indicates that the video resource was deleted.
26
27 - `object: :"video.deleted"`
28
29 The object type that signals the deletion response.
30
31 - `:"video.deleted"`
32
33### Example
34
35```ruby
36require "openai"
37
38openai = OpenAI::Client.new(api_key: "My API Key")
39
40video = openai.videos.delete("video_123")
41
42puts(video)
43```
44
45#### Response
46
47```json
48{
49 "id": "id",
50 "deleted": true,
51 "object": "video.deleted"
52}
53```
54
55### Example
56
57```ruby
58require "openai"
59
60openai = OpenAI::Client.new
61
62video = openai.videos.delete("video_123")
63
64puts(video)
65```