Delete video
client.Videos.Delete(ctx, videoID) (*VideoDeleteResponse, error)
delete /videos/{video_id}
Permanently delete a completed or failed video and its stored assets.
Parameters
videoID string
Returns
-
type VideoDeleteResponse struct{…}Confirmation payload returned after deleting a video.
-
ID stringIdentifier of the deleted video.
-
Deleted boolIndicates that the video resource was deleted.
-
Object VideoDeletedThe object type that signals the deletion response.
const VideoDeletedVideoDeleted VideoDeleted = "video.deleted"
-
Example
package main
import (
"context"
"fmt"
"github.com/openai/openai-go"
"github.com/openai/openai-go/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"),
)
video, err := client.Videos.Delete(context.TODO(), "video_123")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", video.ID)
}
Response
{
"id": "id",
"deleted": true,
"object": "video.deleted"
}
Example
package main
import (
"context"
"fmt"
"github.com/openai/openai-go"
)
func main() {
client := openai.NewClient()
video, err := client.Videos.Delete(context.TODO(), "video_123")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", video.ID)
}