cli/resources/videos/methods/delete/index.md +0 −49 deleted
File Deleted View Diff
1## Delete video
2
3`$ openai videos delete`
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 The identifier of the video to delete.
14
15### Returns
16
17- `VideoDeleteResponse: object { id, deleted, object }`
18
19 Confirmation payload returned after deleting a video.
20
21 - `id: string`
22
23 Identifier of the deleted video.
24
25 - `deleted: boolean`
26
27 Indicates that the video resource was deleted.
28
29 - `object: "video.deleted"`
30
31 The object type that signals the deletion response.
32
33### Example
34
35```cli
36openai videos delete \
37 --api-key 'My API Key' \
38 --video-id video_123
39```
40
41#### Response
42
43```json
44{
45 "id": "id",
46 "deleted": true,
47 "object": "video.deleted"
48}
49```