v4

latestOpenAPI 3.1.02026-08-086635375.7 KB

Avatars

delete avatar

Delete an avatar by ID. By default this is a soft delete: the avatar is hidden and can be restored. Pass hard=true to permanently purge the avatar and its stored assets (source image and generated versions). A hard delete cannot be undone and is intended for data-erasure requests; it also purges avatars that were previously soft-deleted. A hard delete never deletes personas: when active personas (or their drafts) still use the avatar the request fails with 409 Conflict and the impacted persona IDs. Move those personas to another avatar (e.g. PUT /v1/personas/{id} with a new avatarId) and retry.

delete/v1/avatars/{id}

Path parameters

idstring uuid required

Avatar ID

Query parameters

hardboolean

When true, permanently deletes the avatar and purges its stored source and generated assets instead of soft-deleting it.

Response

Successfully deleted avatar

messagestring

Example response

{
  "message": "Avatar deleted successfully"
}