curl -X DELETE "https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
console.log(response.status, (await response.json()).message);
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
print(response.status_code, response.json()["message"])
{
"success": true,
"message": "Avatar deleted",
"data": {
"avatarId": "cm7a1v9t20003ab12cd34ef56",
"deleted": true
}
}
{
"success": false,
"message": "Avatar is still being generated"
}
Avatars
Delete Avatar
Delete one of your team’s own avatars for good
DELETE
/
v1
/
avatar
/
{avatarId}
curl -X DELETE "https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
console.log(response.status, (await response.json()).message);
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
print(response.status_code, response.json()["message"])
{
"success": true,
"message": "Avatar deleted",
"data": {
"avatarId": "cm7a1v9t20003ab12cd34ef56",
"deleted": true
}
}
{
"success": false,
"message": "Avatar is still being generated"
}
Overview
Deletes one of your team’s own avatars, as deleting an actor does in the dashboard.This cannot be undone. The avatar, its image and its Hook + Demo reactions are deleted. Videos already rendered are not affected, but the avatar and its reactions can no longer be used in a new project.
404, like another team’s avatar or an id that does not exist.
When it is refused
Nothing is deleted and the answer is409 while:
message | What to do |
|---|---|
Avatar is still being generated | Wait until Get Avatar says COMPLETED or FAILED. |
Cannot delete: this avatar is used in the project "…", which is still processing | Wait for that project (or a project using one of the avatar’s reactions) to finish. |
Cannot delete: a reaction of this avatar is still being generated | Wait for the reaction to finish. |
curl -X DELETE "https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56" \
-H "x-api-key: your_api_key_here"
const response = await fetch("https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56", {
method: "DELETE",
headers: { "x-api-key": process.env.HOOKED_API_KEY },
});
console.log(response.status, (await response.json()).message);
import os
import requests
response = requests.delete(
"https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56",
headers={"x-api-key": os.environ["HOOKED_API_KEY"]},
)
print(response.status_code, response.json()["message"])
{
"success": true,
"message": "Avatar deleted",
"data": {
"avatarId": "cm7a1v9t20003ab12cd34ef56",
"deleted": true
}
}
{
"success": false,
"message": "Avatar is still being generated"
}
Authorizations
Path Parameters
The id of one of your team's own avatars (from List Avatars with type=custom, or a create call). Library avatars are not accepted here.