curl --request GET \
--url https://apis.viggle.ai/v1/characters/{character_id}/export \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/characters/{character_id}/export"
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/characters/{character_id}/export', 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/characters/{character_id}/export",
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/characters/{character_id}/export"
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/characters/{character_id}/export")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/characters/{character_id}/export")
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_body{
"id": "<string>",
"status": "queued",
"download_type": "vsplat",
"vsplat_url": "<string>",
"thumbnail_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}Export 3D Character (for 3D/game engines)
Get a signed download URL for a Character’s vsplat extraction.
curl --request GET \
--url https://apis.viggle.ai/v1/characters/{character_id}/export \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/v1/characters/{character_id}/export"
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/characters/{character_id}/export', 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/characters/{character_id}/export",
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/characters/{character_id}/export"
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/characters/{character_id}/export")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/v1/characters/{character_id}/export")
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_body{
"id": "<string>",
"status": "queued",
"download_type": "vsplat",
"vsplat_url": "<string>",
"thumbnail_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "authentication_required",
"message": "<string>",
"request_id": "<string>"
}
}type vsplat or all; a render-only Character has nothing to export. This replaces the old, now-removed GET /v1/avatars/{avatar_id}.
vsplat_url and thumbnail_url are populated on different conditions, not both gated by download_type:
vsplat_urlis populated only when the request carriesdownload_type=vsplat, and is re-signed on every call.thumbnail_urlis unconditional — it’s a default output of the extraction, populated whenever one was rendered (that is, the Character was created withrender_thumbnail=true; see Create Character), independent ofdownload_typeand even if it’s omitted entirely. It’s not something you opt into via a request parameter.
glb output for a Character export. download_type only ever accepts vsplat — glb is a Motion-only extraction; see Export 3D Motion (for 3D/game engines) for that.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
character_id | string | Yes | Complete public Character ID returned by Create or List Characters. The Character must have been created with type=vsplat or all to expose an export. |
download_type | string | No | Selects the vsplat download URL: only vsplat is accepted. Any other value — including the old thumbnail, or glb (a Motion-only extraction) — is rejected with 400. Omit to retrieve status (and thumbnail_url, if one exists) only. |
Response parameters
Returns200 OK.
| Field | Type | Always present | Description |
|---|---|---|---|
id | string | Yes | Requested public Character ID. |
status | string | Yes | queued, processing, ready, or failed. |
download_type | string or null | Yes | Echoes the requested download_type (always vsplat or null; never thumbnail). |
vsplat_url | string or null | Yes | Populated only when download_type=vsplat and the extraction is ready. |
thumbnail_url | string or null | Yes | Populated whenever the extraction rendered a thumbnail and it’s ready — regardless of download_type. null if the Character was created with render_thumbnail=false (the default) or the thumbnail isn’t ready yet. |
created_at | string or null | Yes | ISO 8601 timestamp with a UTC offset. May be an empty string on a task that has not recorded one. |
updated_at | string or null | Yes | ISO 8601 timestamp of the most recent update. |
error | object or null | Yes | Structured failure details when status is failed. |
download_type=vsplat on a Character that was also created with render_thumbnail=true — both URLs come back together:
{
"id": "char_550e8400-e29b-41d4-a716-446655440000",
"status": "ready",
"download_type": "vsplat",
"vsplat_url": "https://assets.viggle.ai/results/character.vsplat",
"thumbnail_url": "https://assets.viggle.ai/results/character_thumb.png",
"created_at": "2026-07-31T09:15:22+00:00",
"updated_at": "2026-07-31T09:16:40+00:00",
"error": null
}
download_type at all — vsplat_url withholds, thumbnail_url still doesn’t:
{
"id": "char_550e8400-e29b-41d4-a716-446655440000",
"status": "ready",
"download_type": null,
"vsplat_url": null,
"thumbnail_url": "https://assets.viggle.ai/results/character_thumb.png",
"created_at": "2026-07-31T09:15:22+00:00",
"updated_at": "2026-07-31T09:16:40+00:00",
"error": null
}
Examples
req,_:=http.NewRequest("GET","https://apis.viggle.ai/v1/characters/"+characterID+"/export?download_type=vsplat",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/characters/${characterId}/export?download_type=vsplat`,{headers:{Authorization:`Bearer ${process.env.VIGGLE_API_KEY}`}}); const exported=await response.json();
import os, requests
response=requests.get(f"https://apis.viggle.ai/v1/characters/{character_id}/export",params={"download_type":"vsplat"},headers={"Authorization":f"Bearer {os.environ['VIGGLE_API_KEY']}"}); response.raise_for_status(); exported=response.json()
curl "https://apis.viggle.ai/v1/characters/$CHARACTER_ID/export?download_type=vsplat" -H "Authorization: Bearer $VIGGLE_API_KEY"
download_type again rather than caching the URL.Next step
The 2D render side of this same Character (capabilities: ["video_render"]) is independent of the vsplat export above — use Render Video (from Character and/or Motion) with character_id once it’s ready.Authorizations
Server-side SDK clients use a project API key. Remote MCP clients use an OAuth access token. Never expose a project API key in browser code.
Headers
Optional caller-supplied correlation ID, up to 128 characters. The service returns the effective value in the response header for tracing and support.
1 - 128Optional source-channel label, up to 128 characters, used to attribute traffic to an SDK, integration, product surface, or internal workflow.
1 - 128Path Parameters
Public Character ID returned by character creation or listing. It normally begins with char_ and must identify a Character owned by the caller.
1Query Parameters
Selects the signed output URL to populate. Use vsplat after extraction is ready; omit it when only checking status or retrieving the thumbnail.
vsplat Response
Current vsplat export state.
A character's vsplat extraction, for download. vsplat_url is
populated only when the request carried download_type=vsplat.
thumbnail_url is unconditional — a default output of the
extraction, populated whenever one was rendered, independent of
download_type. Download URLs are short-lived and re-signed on
every read. Formerly AvatarResource, returned by the now-removed
GET /v1/avatars/{avatar_id}.
ID of the Character whose vsplat export is represented.
1Current lifecycle of the vsplat extraction. Download only when this is ready and vsplat_url is populated.
queued, processing, ready, failed, cancelled Echoes the requested download_type; vsplat selects the signed asset URL, while null means no downloadable artifact was explicitly requested.
vsplat, null Short-lived signed URL for the .vsplat asset when download_type=vsplat and extraction is ready; otherwise null.
Short-lived signed URL for the standard extraction thumbnail when one was generated; independent of download_type, otherwise null.
ISO 8601 timestamp with a UTC offset. May be an empty string on a task that has not recorded one.
ISO 8601 timestamp with a UTC offset for the latest extraction-state update; null if unavailable.
Structured extraction failure when status is failed; otherwise null.
Show child attributes
Show child attributes

