java/resources/videos/methods/delete/index.md +0 −85 deleted
File Deleted View Diff
1## Delete video
2
3`VideoDeleteResponse videos().delete(VideoDeleteParamsparams = VideoDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
4
5**delete** `/videos/{video_id}`
6
7Permanently delete a completed or failed video and its stored assets.
8
9### Parameters
10
11- `VideoDeleteParams params`
12
13 - `Optional<String> videoId`
14
15### Returns
16
17- `class VideoDeleteResponse:`
18
19 Confirmation payload returned after deleting a video.
20
21 - `String id`
22
23 Identifier of the deleted video.
24
25 - `boolean deleted`
26
27 Indicates that the video resource was deleted.
28
29 - `JsonValue; object_ "video.deleted"constant`
30
31 The object type that signals the deletion response.
32
33 - `VIDEO_DELETED("video.deleted")`
34
35### Example
36
37```java
38package com.openai.example;
39
40import com.openai.client.OpenAIClient;
41import com.openai.client.okhttp.OpenAIOkHttpClient;
42import com.openai.models.videos.VideoDeleteParams;
43import com.openai.models.videos.VideoDeleteResponse;
44
45public final class Main {
46 private Main() {}
47
48 public static void main(String[] args) {
49 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
50
51 VideoDeleteResponse video = client.videos().delete("video_123");
52 }
53}
54```
55
56#### Response
57
58```json
59{
60 "id": "id",
61 "deleted": true,
62 "object": "video.deleted"
63}
64```
65
66### Example
67
68```java
69package com.openai.example;
70
71import com.openai.client.OpenAIClient;
72import com.openai.client.okhttp.OpenAIOkHttpClient;
73import com.openai.models.videos.VideoDeleteParams;
74import com.openai.models.videos.VideoDeleteResponse;
75
76public final class Main {
77 private Main() {}
78
79 public static void main(String[] args) {
80 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
81
82 VideoDeleteResponse video = client.videos().delete("video_123");
83 }
84}
85```