> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hooked.so/llms.txt
> Use this file to discover all available pages before exploring further.
# Delete Avatar
> Delete one of your team's own avatars for good
## 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.
Library avatars cannot be deleted: their ids answer `404`, like another team's avatar or an id that does not exist.
## When it is refused
Nothing is deleted and the answer is `409` while:
| `message` | What to do |
| - | - |
| `Avatar is still being generated` | Wait until [Get Avatar](/api-reference/avatar/details) 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. |
```bash cURL theme={null}
curl -X DELETE "https://api.hooked.so/v1/avatar/cm7a1v9t20003ab12cd34ef56" \
-H "x-api-key: your_api_key_here"
```
```javascript JavaScript theme={null}
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);
```
```python Python theme={null}
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"])
```
```json 200 theme={null}
{
"success": true,
"message": "Avatar deleted",
"data": {
"avatarId": "cm7a1v9t20003ab12cd34ef56",
"deleted": true
}
}
```
```json 409 theme={null}
{
"success": false,
"message": "Avatar is still being generated"
}
```
## OpenAPI
````yaml DELETE /v1/avatar/{avatarId}
openapi: 3.0.0
info:
title: Hooked API
version: 1.0.0
description: AI Video Generation API
servers:
- url: https://api.hooked.so
security:
- ApiKeyAuth: []
tags:
- name: Videos
description: Create projects, follow them and render videos
- name: Account Analysis
description: Analyze TikTok and YouTube accounts
- name: Channels
description: Connected social accounts you publish to
- name: Publish
description: Schedule videos to your connected accounts
- name: Images
description: 'Image editing: background removal and expansion'
- name: Media
description: 'Your media library: list, import from a URL, upload a file'
- name: Avatars
description: Your team's own avatars (Actors) and their Hook + Demo reactions
paths:
/v1/avatar/{avatarId}:
delete:
tags:
- Avatars
summary: Delete Avatar
description: >-
Deletes one of your team's own avatars for good, as the dashboard does:
its image and the avatar, and its reactions with it. **This cannot be
undone.** Videos already rendered are not affected. Refused with `409`
(nothing deleted) while its generation is still running, while a project
using it or one of its reactions is processing, or while one of its
reactions is being made. Library avatars cannot be deleted.
operationId: deleteAvatar
parameters:
- name: avatarId
in: path
required: true
schema:
type: string
description: >-
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.
responses:
'200':
description: Avatar deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
data:
type: object
required:
- avatarId
- deleted
properties:
avatarId:
type: string
description: The avatar that was deleted
deleted:
type: boolean
description: Always `true`
example:
success: true
message: Avatar deleted
data:
avatarId: cm7a1v9t20003ab12cd34ef56
deleted: true
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/EntitlementRequired'
'404':
description: >-
No such avatar of your team (a library avatar, another team's, a
deleted or a malformed id answer the same)
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound404'
example:
success: false
message: Avatar not found
'409':
description: The avatar cannot be deleted yet; nothing was deleted
content:
application/json:
schema:
$ref: '#/components/schemas/Conflict409'
examples:
generating:
value:
success: false
message: Avatar is still being generated
in use:
value:
success: false
message: >-
Cannot delete: this avatar is used in the project "Serum
ad", which is still processing
reaction:
value:
success: false
message: >-
Cannot delete: a reaction of this avatar is still being
generated
'429':
$ref: '#/components/responses/RateLimited429'
'500':
$ref: '#/components/responses/InternalError'
security:
- ApiKeyAuth: []
components:
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
EntitlementRequired:
description: The team does not have the product this endpoint needs
content:
application/json:
schema:
$ref: '#/components/schemas/EntitlementRequired403'
RateLimited429:
description: >-
Your team is over a rate limit: 30 POST requests per minute, 120 other
requests per minute, or 3 downloads of your URLs running at once.
Nothing ran and nothing was charged: wait `Retry-After` seconds and send
the request again. See [Rate
limits](/guides/error-handling#rate-limits-429).
headers:
Retry-After:
description: Seconds to wait before sending again.
schema:
type: integer
X-RateLimit-Limit:
description: The limit of the bucket you hit (not sent for the download cap).
schema:
type: integer
X-RateLimit-Remaining:
description: 'Requests left in this window: 0 (not sent for the download cap).'
schema:
type: integer
X-RateLimit-Reset:
description: >-
When the window ends, in Unix seconds (not sent for the download
cap).
schema:
type: integer
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- RATE_LIMITED
message:
type: string
retryAfterSeconds:
type: integer
required:
- success
- errorCode
- message
- retryAfterSeconds
example:
success: false
errorCode: RATE_LIMITED
message: >-
Rate limit exceeded: 30 POST requests per minute per team. Retry
after 12 s.
retryAfterSeconds: 12
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500'
schemas:
NotFound404:
type: object
description: >-
Not found. Another team's resource answers the same way as a missing
one.
properties:
success:
type: boolean
enum:
- false
message:
type: string
required:
- success
- message
example:
success: false
message: Project not found
Conflict409:
type: object
description: >-
The resource cannot be deleted right now. `message` says why; nothing
was deleted.
properties:
success:
type: boolean
enum:
- false
message:
type: string
data:
type: object
properties:
scheduleIds:
type: array
items:
type: string
description: >-
The pending scheduled posts in the way. Cancel each with DELETE
/v1/schedule/{scheduleId}, then retry.
required:
- success
- message
Error401:
type: object
description: Missing or invalid `x-api-key`.
properties:
code:
type: string
enum:
- not_authenticated
message:
type: string
example: Not authenticated
errorCode:
type: string
enum:
- NOT_AUTHENTICATED
details:
type: object
additionalProperties:
type: string
example:
code: not_authenticated
message: Not authenticated
errorCode: NOT_AUTHENTICATED
details:
x-api-key: Header not provided or API Key invalid
EntitlementRequired403:
type: object
description: >-
Valid key, but the team does not have the product this endpoint belongs
to.
properties:
code:
type: string
enum:
- entitlement_required
error:
type: string
enum:
- entitlement_required
message:
type: string
product:
type: string
example: app
required:
- code
- error
- message
- product
example:
code: entitlement_required
error: entitlement_required
message: This endpoint requires the "app" product.
product: app
Error500:
type: object
properties:
success:
type: boolean
enum:
- false
message:
type: string
error:
type: string
description: Present on some endpoints
example:
success: false
message: Internal server error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.