Introduction

Welcome to the Luxia Chatbot API. This documentation provides detailed guidance on interacting with our chatbot's endpoints to perform various tasks such as analysis, database checks, and data explanations.

Base URL

https://tenant_id.luxia.tech:5000/apidocs

Endpoints

1. Run Analysis (/run-analysis)

Description: Executes analysis based on user queries, database information, and additional parameters provided.

Method:

Headers:

Header Description Example
X-Organization-Id Organization ID test_org
X-Tenant-Db Tenant DB identifier tenant_XXXXXX
Accept-Language Response language preference en

Payload (example):

{
  "chatId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "userString": "What is the total sales for the last month?",
  "metadata": {
    "schema_name": "public",
    "tables": [{
      "name": "sales",
      "columns": [{
        "name": "sales_amount",
        "type": "FLOAT",
        "analysis": true
      }]
    }]
  }
}

Responses:

The /run_analysis endpoint provides dynamically generated analytical responses based on user-submitted queries and database content. Depending on the nature of the request, responses are provided in different formats:

Description: Returns a textual or numerical response, often used for single-value queries or descriptive answers.