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}

delete avatar

cURL

curl --request DELETE \
  --url https://api.anam.ai/v1/avatars/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.anam.ai/v1/avatars/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anam.ai/v1/avatars/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/avatars/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/avatars/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.anam.ai/v1/avatars/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/avatars/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "message": "Avatar deleted successfully"
}

{
  "error": "Avatar is used by active personas. Move them to another avatar before hard-deleting it.",
  "impactedPersonaIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

Avatar ID

Query Parameters

hard · boolean

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

Response

200

application/json

Successfully deleted avatar

message · string

Example:

"Avatar deleted successfully"