Get Avatar
curl --request GET \
--url https://apis.viggle.ai/v1/avatars/{avatar_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/avatars/{avatar_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/v1/avatars/{avatar_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://apis.viggle.ai/v1/avatars/{avatar_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://apis.viggle.ai/v1/avatars/{avatar_id}"
req, _ := http.NewRequest("GET", 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.get("https://apis.viggle.ai/v1/avatars/{avatar_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/avatars/{avatar_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body3D Conversion
Get Avatar
Retrieve the status and output of an image-to-3D conversion.
GET
/
v1
/
avatars
/
{avatar_id}
Get Avatar
curl --request GET \
--url https://apis.viggle.ai/v1/avatars/{avatar_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/avatars/{avatar_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/v1/avatars/{avatar_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://apis.viggle.ai/v1/avatars/{avatar_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://apis.viggle.ai/v1/avatars/{avatar_id}"
req, _ := http.NewRequest("GET", 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.get("https://apis.viggle.ai/v1/avatars/{avatar_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/avatars/{avatar_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyGET /v1/avatars/{avatar_id} retrieves an Avatar conversion. Poll every 5 seconds until it is ready or failed.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
avatar_id | string | Yes | Full public Avatar ID beginning with avatar_. |
Response parameters
Returns200 OK with a conversion object.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | Yes | Requested public Avatar ID. |
status | string | Yes | queued, processing, ready, or failed. |
model_url | string or null | Yes | Downloadable 3D result when ready. |
created_at | string or null | Yes | ISO 8601 creation timestamp when available. |
updated_at | string or null | Yes | ISO 8601 most-recent update timestamp when available. |
error | object or null | Yes | Structured failure details when status is failed. |
{"id":"avatar_123abc","status":"ready","model_url":"https://assets.viggle.ai/results/avatar.glb","created_at":"2026-07-21T10:00:00Z","updated_at":"2026-07-21T10:01:00Z","error":null}
Examples
req,_:=http.NewRequest("GET","https://apis.viggle.ai/v1/avatars/avatar_123abc",nil); req.Header.Set("Authorization","Bearer "+os.Getenv("VIGGLE_API_KEY")); resp,err:=http.DefaultClient.Do(req); if err!=nil {panic(err)}; defer resp.Body.Close()
const response=await fetch("https://apis.viggle.ai/v1/avatars/avatar_123abc",{headers:{Authorization:`Bearer ${process.env.VIGGLE_API_KEY}`}}); const avatar=await response.json();
import os, requests
response=requests.get("https://apis.viggle.ai/v1/avatars/avatar_123abc",headers={"Authorization":f"Bearer {os.environ['VIGGLE_API_KEY']}"}); response.raise_for_status(); avatar=response.json()
curl "https://apis.viggle.ai/v1/avatars/avatar_123abc" -H "Authorization: Bearer $VIGGLE_API_KEY"
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200
Avatar
⌘I

