Get an Avatar
curl --request GET \
--url https://console.spatius.ai/v1/open/avatars/{avatarId} \
--header 'X-API-Key: <api-key>' \
--header 'X-App-ID: <api-key>'import requests
url = "https://console.spatius.ai/v1/open/avatars/{avatarId}"
headers = {
"X-App-ID": "<api-key>",
"X-API-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-App-ID': '<api-key>', 'X-API-Key': '<api-key>'}};
fetch('https://console.spatius.ai/v1/open/avatars/{avatarId}', 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://console.spatius.ai/v1/open/avatars/{avatarId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>",
"X-App-ID: <api-key>"
],
]);
$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://console.spatius.ai/v1/open/avatars/{avatarId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-App-ID", "<api-key>")
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.spatius.ai/v1/open/avatars/{avatarId}")
.header("X-App-ID", "<api-key>")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.spatius.ai/v1/open/avatars/{avatarId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-App-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"avatar": {
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"name": "Support Agent",
"coverUrl": "https://cdn.spatius.ai/avatars/a1b2c3d4/cover.png",
"backgroundImageUrl": "https://cdn.spatius.ai/avatars/a1b2c3d4/background.png",
"createdAt": "2026-07-25T09:47:12Z",
"updatedAt": "2026-07-25T09:47:12Z"
}
}{
"error": {
"code": "invalid_request",
"message": "imageUrl is required",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized.",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "forbidden",
"message": "API Avatar creation is disabled",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "not_found",
"message": "Avatar job not found",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Open API rate limit exceeded",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "internal_error",
"message": "An internal error occurred.",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}Avatars
Get an Avatar
Returns a single Studio Avatar owned by the authenticated account.
GET
/
avatars
/
{avatarId}
Get an Avatar
curl --request GET \
--url https://console.spatius.ai/v1/open/avatars/{avatarId} \
--header 'X-API-Key: <api-key>' \
--header 'X-App-ID: <api-key>'import requests
url = "https://console.spatius.ai/v1/open/avatars/{avatarId}"
headers = {
"X-App-ID": "<api-key>",
"X-API-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-App-ID': '<api-key>', 'X-API-Key': '<api-key>'}};
fetch('https://console.spatius.ai/v1/open/avatars/{avatarId}', 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://console.spatius.ai/v1/open/avatars/{avatarId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>",
"X-App-ID: <api-key>"
],
]);
$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://console.spatius.ai/v1/open/avatars/{avatarId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-App-ID", "<api-key>")
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.spatius.ai/v1/open/avatars/{avatarId}")
.header("X-App-ID", "<api-key>")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.spatius.ai/v1/open/avatars/{avatarId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-App-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"avatar": {
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"name": "Support Agent",
"coverUrl": "https://cdn.spatius.ai/avatars/a1b2c3d4/cover.png",
"backgroundImageUrl": "https://cdn.spatius.ai/avatars/a1b2c3d4/background.png",
"createdAt": "2026-07-25T09:47:12Z",
"updatedAt": "2026-07-25T09:47:12Z"
}
}{
"error": {
"code": "invalid_request",
"message": "imageUrl is required",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized.",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "forbidden",
"message": "API Avatar creation is disabled",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "not_found",
"message": "Avatar job not found",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Open API rate limit exceeded",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}{
"error": {
"code": "internal_error",
"message": "An internal error occurred.",
"requestId": "b3f0c2d1-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
}
}⌘I

