Create an avatar
curl --request POST \
--url https://api.waterr.ai/v1/avatars \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://your-cdn.com/avatars/alex.jpg",
"category": "<string>",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {}
}
'import requests
url = "https://api.waterr.ai/v1/avatars"
payload = {
"url": "https://your-cdn.com/avatars/alex.jpg",
"category": "<string>",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://your-cdn.com/avatars/alex.jpg',
category: '<string>',
default_voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
tags: {}
})
};
fetch('https://api.waterr.ai/v1/avatars', 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.waterr.ai/v1/avatars",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://your-cdn.com/avatars/alex.jpg',
'category' => '<string>',
'default_voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.waterr.ai/v1/avatars"
payload := strings.NewReader("{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.waterr.ai/v1/avatars")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterr.ai/v1/avatars")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "https://waterr-ai-avatars.s3.us-east-1.amazonaws.com/F-1.jpg",
"category": "professional",
"gender": "male",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "curated",
"owner_membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {},
"width": 123,
"height": 123,
"Voice": {
"id": "<string>",
"partner_voice_id": "<string>",
"name": "<string>",
"provider": "<string>",
"user_basic_info_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Avatars
Create an avatar
Register a hosted image as an account-owned avatar you can assign to any of your personas.
POST
/
avatars
Create an avatar
curl --request POST \
--url https://api.waterr.ai/v1/avatars \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://your-cdn.com/avatars/alex.jpg",
"category": "<string>",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {}
}
'import requests
url = "https://api.waterr.ai/v1/avatars"
payload = {
"url": "https://your-cdn.com/avatars/alex.jpg",
"category": "<string>",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://your-cdn.com/avatars/alex.jpg',
category: '<string>',
default_voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
tags: {}
})
};
fetch('https://api.waterr.ai/v1/avatars', 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.waterr.ai/v1/avatars",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://your-cdn.com/avatars/alex.jpg',
'category' => '<string>',
'default_voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'tags' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.waterr.ai/v1/avatars"
payload := strings.NewReader("{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.waterr.ai/v1/avatars")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterr.ai/v1/avatars")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://your-cdn.com/avatars/alex.jpg\",\n \"category\": \"<string>\",\n \"default_voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "https://waterr-ai-avatars.s3.us-east-1.amazonaws.com/F-1.jpg",
"category": "professional",
"gender": "male",
"default_voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "curated",
"owner_membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {},
"width": 123,
"height": 123,
"Voice": {
"id": "<string>",
"partner_voice_id": "<string>",
"name": "<string>",
"provider": "<string>",
"user_basic_info_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.
Body
application/json
Public https URL of the image (jpeg, png, or webp; max 10MB; min 128×128px). Fetched once at creation and re-hosted — the original is kept in tags.source_url for reference but never loaded again.
Example:
"https://your-cdn.com/avatars/alex.jpg"
Defaults to professional.
Drives voice pairing when assigned to a persona.
Available options:
male, female, neutral Voice to pair when assigning with sync_voice: true.
Response
Avatar created — data.url is the re-hosted WaterrAI URL; width/height are measured from the actual image

