Get Character

curl --request GET \
  --url https://apis.viggle.ai/api/characters/{character_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apis.viggle.ai/api/characters/{character_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/api/characters/{character_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/api/characters/{character_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/api/characters/{character_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/api/characters/{character_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/characters/{character_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_body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Character",
  "has_v3_encoding": false,
  "has_v4_encoding": true,
  "job_id": "char_550e8400e29b",
  "error": "<string>",
  "error_message": "<string>",
  "thumbnail_url": "<string>",
  "credits_used": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Character not found. Double-check the character_id."
  }
}

GET

api

characters

{character_id}

Get Character

curl --request GET \
  --url https://apis.viggle.ai/api/characters/{character_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apis.viggle.ai/api/characters/{character_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/api/characters/{character_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/api/characters/{character_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/api/characters/{character_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/api/characters/{character_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/characters/{character_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_body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Character",
  "has_v3_encoding": false,
  "has_v4_encoding": true,
  "job_id": "char_550e8400e29b",
  "error": "<string>",
  "error_message": "<string>",
  "thumbnail_url": "<string>",
  "credits_used": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Character not found. Double-check the character_id."
  }
}

Pulls up everything about a single character — where it is in processing, and which model encodings are ready to use. This is the endpoint you’ll poll after creating a character to know when it’s ready.

Check back every 5 seconds or so until status turns ready (then look at has_v3_encoding / has_v4_encoding to see which model is good to go) — or failed.

Path parameters

Parameter	Type	Required	Description
`character_id`	string	✅	The character UUID returned when you created it.

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Character",
  "status": "ready",
  "has_v3_encoding": true,
  "has_v4_encoding": false,
  "thumbnail_url": "https://cdn.viggle.ai/characters/....png",
  "credits_used": 1.0,
  "created_at": "2026-06-12T08:00:00Z",
  "completed_at": "2026-06-12T08:00:42Z"
}

Field	Description
`status`	`pending`, `processing`, `ready`, or `failed`. Only `ready` characters can be rendered.
`has_v3_encoding` / `has_v4_encoding`	Whether the character is ready for `V3_Preview` / `V4_Preview` renders. Must match the model you render with.
`thumbnail_url`	Preview image of the processed character, once available.
`error_message`	Why processing failed. Present only when `status` is `failed`.
`credits_used`	Credits actually charged for preprocessing.

Example

import requests

character_id = "YOUR_CHARACTER_ID"
url = f"https://apis.viggle.ai/api/characters/{character_id}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers)
response.raise_for_status()
result = response.json()

print(f"Name: {result['name']}")
print(f"Status: {result['status']}")

const characterId = "YOUR_CHARACTER_ID";

const response = await fetch(`https://apis.viggle.ai/api/characters/${characterId}`, {
  headers: { "Authorization": "Bearer YOUR_API_KEY" },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const result = await response.json();
console.log(`Name: ${result.name}`);
console.log(`Status: ${result.status}`);

curl -X GET https://apis.viggle.ai/api/characters/YOUR_CHARACTER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Next steps

Once status is ready and the encoding you need is true, use the character’s id as character_id in a render job.

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Path Parameters

character_id

string

required

Response

Character details

string

Example:

"550e8400-e29b-41d4-a716-446655440000"

name

string

Example:

"My Character"

status

enum<string>

Available options:

pending,

processing,

ready,

failed

has_v3_encoding

boolean

Whether V3_Preview embedding is available for this character

Example:

false

has_v4_encoding

boolean

Whether V4_Preview embedding is available for this character

Example:

true

job_id

string | null

Example:

"char_550e8400e29b"

error

string | null

error_message

string | null

thumbnail_url

string<uri> | null

credits_used

number | null

Example:

1

created_at

string<date-time> | null

completed_at

string<date-time> | null

List Characters Delete Character

Characters

Scenes

Render

Extract

Credits

Get Character

Path parameters

Response

Example

Next steps

Authorizations

Path Parameters

Response

​Path parameters

​Response

​Example

​Next steps

Authorizations

Path Parameters

Response

Path parameters

Response

Example

Next steps