python/resources/videos/methods/delete/index.md +0 −68 deleted
File Deleted View Diff
1## Delete video
2
3`videos.delete(strvideo_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: str`
12
13### Returns
14
15- `class VideoDeleteResponse: …`
16
17 Confirmation payload returned after deleting a video.
18
19 - `id: str`
20
21 Identifier of the deleted video.
22
23 - `deleted: bool`
24
25 Indicates that the video resource was deleted.
26
27 - `object: Literal["video.deleted"]`
28
29 The object type that signals the deletion response.
30
31 - `"video.deleted"`
32
33### Example
34
35```python
36import os
37from openai import OpenAI
38
39client = OpenAI(
40 api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
41)
42video = client.videos.delete(
43 "video_123",
44)
45print(video.id)
46```
47
48#### Response
49
50```json
51{
52 "id": "id",
53 "deleted": true,
54 "object": "video.deleted"
55}
56```
57
58### Example
59
60```python
61from openai import OpenAI
62
63client = OpenAI()
64video = client.videos.delete(
65 "video_123",
66)
67print(video.id)
68```