Character metadata

GET /api/v11/characters

Get data for available characters in the system. Paginated. Up to 100 characters per request

Headers

x-access-token string

Query parameters

numCharacters integer Required
from integer

Character ID to start results from (useful in pagination)

Responses

200 application/json

A JSON array of character metadata for each character
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- characters array[object] Required
  
  Hide characters attributes Show characters attributes object
  
  name string Required
  
  description string Required
  
  isOfficial boolean Required
  
  isPrivate boolean Required
  
  id integer Required
- isEndOfList boolean Required
400 application/json

Bad request
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is false.
- error string Required
  
  Value is One or more API parameters are malformed. Please check your request and try again.
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is false.
- error string Required
  
  Value is Invalid username, password, or access token.
429 application/json

User exceeded the message limit for their current plan
One of:
object-2 object object-2 object
Hide attributes Show attributes

success boolean Required

Default value is false.

error string Required

Value is You have exceeded your Message/TTS quota. To send more messages, please upgrade your plan or wait until your subscription renews..
Hide attributes Show attributes

statusCode integer Required

error string Required

message string Required

GET /api/v11/characters

curl \
 -X GET https://chat-api.aurora-interactive.online:8443/api/v11/characters?numCharacters=25 \
 -H "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": true,
  "characters": [
    {
      "name": "string",
      "description": "string",
      "isOfficial": true,
      "isPrivate": true,
      "id": 42
    }
  ],
  "isEndOfList": true
}

Response examples (400)

{
  "success": false,
  "error": "One or more API parameters are malformed. Please check your request and try again"
}

Response examples (401)

{
  "success": false,
  "error": "Invalid username, password, or access token"
}

Response examples (429)

{
  "success": false,
  "error": "You have exceeded your Message/TTS quota. To send more messages, please upgrade your plan or wait until your subscription renews."
}

{
  "statusCode": 42,
  "error": "string",
  "message": "string"
}