AI Chatbot API

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