Skip to content

Delete video

client.videos.delete(stringvideoID, RequestOptionsoptions?): VideoDeleteResponse { id, deleted, object }
DELETE/videos/{video_id}

Delete a video

ParametersExpand Collapse
videoID: string
ReturnsExpand Collapse
VideoDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a video.

id: string

Identifier of the deleted video.

deleted: boolean

Indicates that the video resource was deleted.

object: "video.deleted"

The object type that signals the deletion response.

Delete video

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const video = await client.videos.delete('video_123');

console.log(video.id);
{
  "id": "id",
  "deleted": true,
  "object": "video.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "video.deleted"
}