Skip to main content

​
List Characters

GET /api/characters
Returns a paginated list of characters visible to the API key owner:
  • Public characters (isPublic: true)
  • Private characters owned by the same API key user

​
Query parameters

ParameterTypeDefaultDescription
qstring—Optional case-insensitive search across character name (min 2 chars)
limitinteger24Number of characters to return (max 60)
offsetinteger0Pagination offset

​
Request

curl "https://prismvideos.com/api/characters?limit=10&q=comedian" \
  -H "Authorization: Bearer prism_sk_your_key_here"

​
Response

{
  "data": [
    {
      "id": "d2a7e0d5-1705-43b5-be96-85b9c5f25b80",
      "name": "Rajit Khanna",
      "description": "the cutest little guy in the world",
      "created_at": 1773361092291
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "has_more": false
  }
}

​
Response fields

​
Character object

FieldTypeDescription
idstringUnique character identifier
namestringCharacter name
descriptionstring or nullCharacter description
created_atnumber or nullUnix timestamp in milliseconds

​
Pagination object

FieldTypeDescription
offsetnumberCurrent offset
limitnumberRequested limit
has_morebooleanWhether more results exist beyond this page

​
Errors

StatusErrorWhen
400validation_errorq is present but shorter than 2 characters
401unauthorizedMissing or invalid API key
500server_errorUnexpected server error while listing characters
See Errors for the full error reference.