Skip to main content
GET
List Characters
Lists all the characters on your account, newest first. Use it to grab a character’s id for rendering, or to see which ones have finished processing and are ready to go. Got a lot of characters? Page through them with limit and offset.

Query parameters

Response

Example

Next steps

Pick a character whose status is ready and use its id as character_id in a render job. To inspect one character, call Get Character.

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Paginated list of characters

characters
object[]
total
integer

Total number of characters returned