Delete message

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 \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/characters?numCharacters=25' \
 --header "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"
}

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 \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/character?characterId=8' \
 --header "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"
}

Create character

POST /api/v11/character

Upload character data to our system

Headers

x-access-token string Required

application/json

Body

name string Required
description string Required
aiPrompt string Required
initialResponse string Required
banner string Required

base64-encoded AVIF image
icon string Required

base64-encoded AVIF image
isPrivate boolean Required
specialMessages array[object] Required
Hide specialMessages attributes Show specialMessages attributes object
- startsWith string Required
- endsWith array[string] Required
- prompt string Required

Responses

200 application/json

Character was created successfully
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- characterId 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

POST /api/v11/character

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/character' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"name":"string","description":"string","aiPrompt":"string","initialResponse":"string","banner":"AAAAbx","icon":"AAAAbx","isPrivate":true,"specialMessages":[{"startsWith":"string","endsWith":["string"],"prompt":"string"}]}'

Request examples

# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "name": "string",
  "description": "string",
  "aiPrompt": "string",
  "initialResponse": "string",
  "banner": "AAAAbx",
  "icon": "AAAAbx",
  "isPrivate": true,
  "specialMessages": [
    {
      "startsWith": "string",
      "endsWith": [
        "string"
      ],
      "prompt": "string"
    }
  ]
}

Response examples (200)

{
  "success": true,
  "characterId": 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"
}

Login

POST /api/v11/login

Login and retrieve an access token for use with the API

application/json

Responses

200 application/json

Access token to be used with the rest of the API
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- accessToken string 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

POST /api/v11/login

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/login' \
 --header "Content-Type: application/json" \
 --data '{"username":"string","password":"string"}'

Request examples

{
  "username": "string",
  "password": "string"
}

Response examples (200)

{
  "success": true,
  "accessToken": "string"
}

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

Get User Info

GET /api/v11/user/info

Get personal account metadata. Useful for pre-filling update fields for when the user wants to update account data

Headers

x-access-token string Required

Responses

200 application/json

User info
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- username string Required
- email string Required
- autoExecuteTts boolean Required
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/user/info

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/user/info' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": true,
  "username": "string",
  "email": "string",
  "autoExecuteTts": true
}

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

Update account information

PUT /api/v11/user/info

Update information such as your email and username

Headers

x-access-token string Required

application/json

Body

username string Required
email string Required
autoExecuteTts boolean Required
password string Required

Responses

200 application/json

Update account information successfully
Hide response attribute Show response attribute object
- success boolean Required
  
  Default value is true.
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

PUT /api/v11/user/info

curl \
 --request PUT 'https://chat-api.aurora-interactive.online:8443/api/v11/user/info' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"username":"string","email":"string","autoExecuteTts":true,"password":"string"}'

Request examples

# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "username": "string",
  "email": "string",
  "autoExecuteTts": true,
  "password": "string"
}

Response examples (200)

{
  "success": 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"
}

Quota and plan info

GET /api/v11/user/quota

Get information related to the user's subscription quota and plan details.

Headers

x-access-token string Required

Responses

200 application/json

User info
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- quotaUsed integer Required
- quotaMax integer Required
- ttsUsed integer Required
- ttsMax integer Required
- planName string Required
- isChristy boolean Required

GET /api/v11/user/quota

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/user/quota' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": true,
  "quotaUsed": 42,
  "quotaMax": 42,
  "ttsUsed": 42,
  "ttsMax": 42,
  "planName": "string",
  "isChristy": true
}

User signup

POST /api/v11/signup

Create an account

application/json

Responses

200 application/json

Access token to be used with the rest of the API
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- accessToken string 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.
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

POST /api/v11/signup

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/signup' \
 --header "Content-Type: application/json" \
 --data '{"username":"string","email":"string","password":"string"}'

Request examples

{
  "username": "string",
  "email": "string",
  "password": "string"
}

Response examples (200)

{
  "success": true,
  "accessToken": "string"
}

Response examples (400)

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

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

Get all chats assigned to a user

GET /api/v11/chats

Get chat IDs assigned to a user ID

Headers

x-access-token string Required

Responses

200 application/json

JSON array of chat info
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- chats array[object] Required
  
  Hide chats attributes Show chats attributes object
  
  characterId integer Required
  
  chatId 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

GET /api/v11/chats

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/chats' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": true,
  "chats": [
    {
      "characterId": 42,
      "chatId": 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"
}

Get the latest message from the given chat

GET /api/v11/chat/preview

Headers

x-access-token string Required

Query parameters

chatId integer Required

Responses

200 application/json

Latest message in the given chat, useful as a preview
Hide response attributes Show response attributes object
- content string Required
- timestamp 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

GET /api/v11/chat/preview

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/chat/preview?chatId=8' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "content": "string",
  "timestamp": 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"
}

Initialize chat with AI character

POST /api/v11/chat

Initialize a chat with a given AI character, including storing the character's initial response as a message in our system.

Headers

x-access-token string Required

application/json

Body

characterId integer Required

Responses

200 application/json

Chat initialized successfully with the given AI initialization data
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- chatId 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

POST /api/v11/chat

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/chat' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"characterId":42}'

Request examples

# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "characterId": 42
}

Response examples (200)

{
  "success": true,
  "chatId": 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"
}

Delete a chat

DELETE /api/v11/chat

Delete a chat by ID. All messages in the chat are also deleted.

Headers

x-access-token string Required

Query parameters

chatId integer Required

Responses

200 application/json

Chat and all relevant data deleted successfully
Hide response attribute Show response attribute object
- success boolean Required
  
  Default value is true.
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

DELETE /api/v11/chat

curl \
 --request DELETE 'https://chat-api.aurora-interactive.online:8443/api/v11/chat?chatId=8' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": 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"
}

Save chat message

POST /api/v11/message/save

Save chat message after AI response

Headers

x-access-token string Required

application/json

Body

chatId integer Required
role string Required

Values are system, user, or assistant.
content string Required
timestamp integer Required

Responses

200 application/json

Message saved successfully
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- id 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

POST /api/v11/message/save

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/message/save' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"chatId":42,"role":"system","content":"string","timestamp":42}'

Request examples

# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "chatId": 42,
  "role": "system",
  "content": "string",
  "timestamp": 42
}

Response examples (200)

{
  "success": true,
  "id": 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"
}

Get a certain number of messages from the message history, up to 100 per request.

GET /api/v11/messages

Headers

x-access-token string Required

Query parameters

chatId integer Required
numMessages integer Required
from integer

Message ID to start results from (useful in pagination)

Responses

200 application/json

An array of messages that are part of the message history and an indicator of whether there are more messages left.
Hide response attributes Show response attributes object
- success boolean Required
  
  Default value is true.
- messages array[object] Required
  
  Hide messages attributes Show messages attributes object
  
  role string Required
  
  Values are system, user, or assistant.
  
  content string Required
  
  timestamp integer Required
  
  id integer Required
- endOfList 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/messages

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/messages?chatId=8&numMessages=10' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": true,
  "messages": [
    {
      "role": "system",
      "content": "string",
      "timestamp": 42,
      "id": 42
    }
  ],
  "endOfList": 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"
}

Send message

POST /api/v11/message

Send a message to a particular chat for a response

Headers

x-access-token string Required

application/json

Body

characterId integer Required
chatId integer Required
message string Required

Responses

200 text/event-stream

Server Sent Events stream of JSON data of each token as it becomes available, as shown in the documented example. On the stream.on("end") event, no new data is sent.
Hide response attribute Show response attribute object
- data object Required
  
  Additional properties are allowed.
  
  Hide data attribute Show data attribute object
  
  content string 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

POST /api/v11/message

curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/message' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"characterId":42,"chatId":42,"message":"string"}'

Request examples

# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "characterId": 42,
  "chatId": 42,
  "message": "string"
}

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

DELETE /api/v11/message

Remove message from message history by ID

Headers

x-access-token string Required

Query parameters

messageId integer Required

Responses

200 application/json

Message was deleted successfully
Hide response attribute Show response attribute object
- success boolean Required
  
  Default value is true.
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

DELETE /api/v11/message

curl \
 --request DELETE 'https://chat-api.aurora-interactive.online:8443/api/v11/message?messageId=8' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

Response examples (200)

{
  "success": 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"
}

Retrieve text-to-speech generation

GET /api/v11/tts

Retrieve the WAV audio data generated after a successful call to POST /tts

Headers

x-access-token string Required

Query parameters

ttsMessageFor integer Required

Responses

200 application/octet-stream

raw WAV file data from the succcessful text-to-speech generation.
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/tts

curl \
 --request GET 'https://chat-api.aurora-interactive.online:8443/api/v11/tts?ttsMessageFor=42' \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf"

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

Aurora AI Chat REST API 11.4.0

Aurora AI Chat REST API
11.4.0