Skip to main content
DELETE
Delete Index

DELETE /api/v1/search/indexes/

Permanently delete a search index and all its contents. This removes the index, all uploaded items, and all indexed clips.

Path Parameters

Response

Example Request

Example Response

Notes

  • This action is permanent and cannot be undone
  • All items and clips in the index will be deleted
  • Any URLs pointing to clips in this index will become invalid
  • To remove a single item instead, use Delete from Index

Path Parameters

index_id
string
required

The ID of the index to delete

Response

Index deleted successfully

index_id
string
required

ID of the deleted index

Example:

"idx_abc123xyz"

name
string
required

Name of the deleted index

Example:

"Sports Highlights Q4 2024"

items_deleted
integer
required

Number of items that were in the index

Example:

12

clips_deleted
integer
required

Total number of clips that were deleted

Example:

347

message
string
required

Confirmation message

Example:

"Index successfully deleted"