Delete an asset
This method deletes the specified asset. This action cannot be undone.
By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a 409 Conflict error. To skip this check and delete the asset anyway, set the force query parameter to true. The platform unlinks any entity associations.
Before deleting, you can inspect existing references:
- GET /assets/{asset_id}/indexed-assets returns a list of the indexed assets that will block deletion unless the force query parameter is set to true.
- GET /assets/{asset_id}/entities returns a list of the entities whose associations the platform will unlink.
Path parameters
The unique identifier of the asset to delete.
Query parameters
When set to true, the platform deletes the asset even if indexed assets reference it. When set to false or omitted, the request fails with 409 Conflict if references exist.
Default: false.
Headers
Your API key.
<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>Response
Successful response
Changes
Changed in 2 of the 10 revisions of this API.121
- ●
removed the optional property
docs_urlfrom the response with the400statusresponse-optional-property-removed
- ●
removed the optional property
docs_urlfrom the response with the409statusresponse-optional-property-removed
- ●
- ▲
removed the success response with the status
204response-success-status-removed
- ○
added the success response with the status
200response-success-status-added
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲