Delete Brand Image
Learn how to delete brand assets from your workspace
Updated
DELETE
/v1/brand-assets/images/delete/{id}curl -X DELETE "https://api.orshot.com/v1/brand-assets/images/delete/<ID>" \
-H "Authorization: Bearer <ORSHOT_API_KEY>"const res = await fetch("https://api.orshot.com/v1/brand-assets/images/delete/<ID>", {
method: "DELETE",
headers: {
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});
const data = await res.json();import requests
response = requests.delete(
"https://api.orshot.com/v1/brand-assets/images/delete/<ID>",
headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
)
data = response.json()$ch = curl_init("https://api.orshot.com/v1/brand-assets/images/delete/<ID>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer <ORSHOT_API_KEY>",
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);require "net/http"
require "json"
uri = URI("https://api.orshot.com/v1/brand-assets/images/delete/<ID>")
req = Net::HTTP::Delete.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)Overview#
This endpoint allows you to delete a specific brand asset (image) from your workspace using its unique ID.
https://api.orshot.com/v1/brand-assets/images/delete/:idRequest#
await fetch("https://api.orshot.com/v1/brand-assets/images/delete/101", {
method: "DELETE",
headers: {
"Content-Type": "application/json",
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});{
"message": "Asset successfully deleted",
"id": "101"
}Path Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
id | Number | Yes | The unique identifier of the brand asset to delete |
Error Responses#
Asset Not Found (404)#
{
"error": "Asset not found"
}Missing Asset ID (400)#
{
"error": "Asset ID is required"
}Unauthorized (403)#
{
"error": "Access Forbidden"
}Notes#
- The asset must belong to your workspace
- Once deleted, assets cannot be recovered
- The API key must have the appropriate permissions to delete assets
Query Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
embedId | String | No | Embed instance ID. Pair with embedUserId to scope this call to one embed user |
embedUserId | String | No | The same userId your app passes to the embed URL. Requires embedId |
Per-User Libraries#
Pass embedId and embedUserId together to target only that embed user's image, so one user's ID can never delete another's. This is how one embed serves many brands or tenants, each with its own brand space.
Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.
Rate Limits#
- 30 requests per minute per endpoint
Was this page helpful?
Ready to automate?
Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.
Get your API key- Image, PDF and video generation via API
- Visual editor with AI and smart layouts
- Zapier, Make, MCP and 50+ integrations
- White-label embed for your own app
- 30 free credits — no credit card required