Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Kr-Yogsa/ECE-BOT/llms.txt

Use this file to discover all available pages before exploring further.

ECE-BOT supports multiple hardware assistants — MELFA, PLC, and CNC — each backed by a dedicated intent model and knowledge base. Use GET /hardware-list to populate a bot selector in your UI, and POST /select-bot to switch the active assistant before sending chat messages. The active bot is stored server-side in the user’s session and determines which model handles subsequent /chat requests.
Both endpoints require a valid Bearer token. Requests without a token receive a 401 Unauthorized response.

GET /hardware-list

Returns all configured hardware assistants and the ID of the currently active bot.

Request headers

Authorization
string
required
Bearer token obtained at login. Format: Bearer <token>.

Response

hardware
object[]
required
Ordered list of all available hardware assistants.
selected_bot
string
required
The id of the assistant currently active in the session.

Example

curl --request GET \
  --url https://your-ece-bot-host/hardware-list \
  --header 'Authorization: Bearer <token>'
200 response
{
  "hardware": [
    {
      "id": "melfa",
      "name": "MELFA",
      "description": "Support for Mitsubishi MELFA industrial robots.",
      "file": "melfa.json"
    },
    {
      "id": "plc",
      "name": "PLC",
      "description": "Support for programmable logic controller questions.",
      "file": "plc.json"
    },
    {
      "id": "cnc",
      "name": "CNC",
      "description": "Support for CNC machine troubleshooting and usage.",
      "file": "cnc.json"
    }
  ],
  "selected_bot": "melfa"
}

POST /select-bot

Switches the active hardware assistant for the current session. All subsequent /chat requests will use the selected bot until changed.

Request headers

Authorization
string
required
Bearer token obtained at login. Format: Bearer <token>.
Content-Type
string
required
Must be application/json.

Request body

hardware_id
string
required
The id of the hardware assistant to activate. Must be one of the IDs returned by GET /hardware-list ("melfa", "plc", or "cnc").

Response

message
string
required
Confirmation string: "Bot selected successfully.".
selected_bot
string
required
The id of the newly active assistant, echoing the value sent in the request.
selected_name
string
required
Human-readable display name of the newly active assistant.

Errors

StatusCondition
400Request body is missing or hardware_id is absent.
401Missing or invalid Bearer token.
404The supplied hardware_id does not match any configured hardware.

Example

curl --request POST \
  --url https://your-ece-bot-host/select-bot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"hardware_id": "cnc"}'
200 response
{
  "message": "Bot selected successfully.",
  "selected_bot": "cnc",
  "selected_name": "CNC"
}
404 response
{
  "error": "Unknown hardware selected."
}

QR code machine selection

Scanning a machine QR code navigates to /machine/<hardware_id>. ECE-BOT automatically redirects to the login page with the bot pre-selected, so users land directly in the correct hardware context without manually choosing a bot from the dropdown.
The /machine/<hardware_id> route is a browser redirect, not a JSON API endpoint. It is not intended to be called from API clients.

Build docs developers (and LLMs) love