Skip to main content
GET
/
api
/
characters
List Characters
curl --request GET \
  --url https://apis.viggle.ai/api/characters \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.viggle.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of all characters associated with your account, ordered by most recent first.

​
Example

import requests

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

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

for character in result:
    print(f"{character['id']}: {character['name']} ({character['status']})")

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Response

List of characters

​
id
string
​
name
string
​
status
enum<string>
Available options:
pending,
processing,
ready,
failed
​
created_at
string<date-time> | null
​
completed_at
string<date-time> | null