Skip to content

Delete video

VideoDeleteResponse videos().delete(VideoDeleteParamsparams = VideoDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/videos/{video_id}

Delete a video

ParametersExpand Collapse
VideoDeleteParams params
Optional<String> videoId
ReturnsExpand Collapse
class VideoDeleteResponse:

Confirmation payload returned after deleting a video.

String id

Identifier of the deleted video.

boolean deleted

Indicates that the video resource was deleted.

JsonValue; object_ "video.deleted"constant"video.deleted"constant

The object type that signals the deletion response.

Delete video

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");
    }
}
{
  "id": "id",
  "deleted": true,
  "object": "video.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "video.deleted"
}