Skip to main content
GET
/
api
/
characters
/
{character_id}
Get Character
curl --request GET \
  --url https://apis.viggle.ai/api/characters/{character_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Character",
  "status": "pending",
  "job_id": "char_550e8400e29b",
  "error_message": "<string>",
  "credits_used": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}
Retrieve details for a specific character. Use this endpoint to poll for processing status.
Poll every 5 seconds until status is ready or failed.

​
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)
result = response.json()

if result.get("error_code"):
    print(f"Error: {result['error_code']} - {result.get('message')}")
else:
    character = result["data"]
    print(f"Name: {character['name']}")
    print(f"Status: {character['status']}")

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
character_id
string
required

Response

Character details

​
id
string
Example:

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

​
name
string
Example:

"My Character"

​
status
enum<string>
Available options:
pending,
processing,
ready,
failed
​
job_id
string | null
Example:

"char_550e8400e29b"

​
error_message
string | null
​
credits_used
number | null
Example:

1

​
created_at
string<date-time> | null
​
completed_at
string<date-time> | null