Delete video
VideoDeleteResponse videos().delete(VideoDeleteParamsparams = VideoDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
delete /videos/{video_id}
Permanently delete a completed or failed video and its stored assets.
Parameters
-
VideoDeleteParams paramsOptional<String> videoId
Returns
-
class VideoDeleteResponse:Confirmation payload returned after deleting a video.
-
String idIdentifier of the deleted video.
-
boolean deletedIndicates that the video resource was deleted.
-
JsonValue; object_ "video.deleted"constantThe object type that signals the deletion response.
VIDEO_DELETED("video.deleted")
-
Example
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.VideoDeleteParams;
import com.openai.models.videos.VideoDeleteResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
VideoDeleteResponse video = client.videos().delete("video_123");
}
}
Response
{
"id": "id",
"deleted": true,
"object": "video.deleted"
}
Example
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.videos.VideoDeleteParams;
import com.openai.models.videos.VideoDeleteResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
VideoDeleteResponse video = client.videos().delete("video_123");
}
}