Get information about a character

GET /api/v11/character

Headers

x-access-token string

Query parameters

characterId integer Required

Responses

200 application/json

Character data
Hide response attributes Show response attributes object
- name string Required
- description string Required
- isOfficial boolean Required
- isPrivate boolean Required
- ttsCharacter integer 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
403 application/json

The character the user is querying for is private the querying user is not creator
Hide response attribute Show response attribute object
- error string Required
  
  Value is This character is private and you are not the creator.

GET /api/v11/character

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

Response examples (200)

{
  "name": "string",
  "description": "string",
  "isOfficial": true,
  "isPrivate": true,
  "ttsCharacter": 42
}

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"
}

Response examples (403)

{
  "error": "This character is private and you are not the creator"
}