Send message

POST /api/v11/message

Send a message to a particular chat for a response

application/json

Body

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
  • 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
POST /api/v11/message 
curl \
 -X POST https://chat-api.aurora-interactive.online:8443/api/v11/message \
 -H "Content-Type: application/json" \
 -H "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 -d '{"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"
}