Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tutosrive/avl_tree_car/llms.txt

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

The AVL Tree Car Backend exposes a JSON REST API served by Flask on http://localhost:4500. Every route returns a consistent BaseFlaskResponse envelope — no authentication is required and CORS is open to all origins (*). POST requests must send a Content-Type: application/json header with a JSON body; GET requests carry no body. Two resource groups exist: /avl for managing the self-balancing obstacle tree, and /data for reading static JSON configuration files from the server.

​
Base URL

http://localhost:4500
All routes are registered both with and without a trailing slash — POST /avl/node/add and POST /avl/node/add/ are identical. See the Router source for details.

​
Authentication

No authentication is required. The server applies a permissive CORS policy (*) so any origin may call any endpoint without tokens or API keys.

​
Request format

For all POST endpoints, send a JSON body with the appropriate Content-Type header: 
Content-Type: application/json
GET endpoints accept no request body.

​
Response format

Every response — success or error — follows the BaseFlaskResponse shape: 
{
  "status": 200,
  "ok": true,
  "message": "Human-readable result",
  "data": {},
  "error": null
}
FieldTypeDescription
statusintegerHTTP status code mirrored inside the body
okbooleantrue on success, false on any error
messagestringHuman-readable description of the outcome
dataobject | array | stringResponse payload; {} when empty
errorstring | nullError detail or null on success

​
HTTP status codes

CodeMeaning
200Success
400Bad request — validation error, duplicate node, or resource not found
500Server-side exception during processing

​
Endpoint summary

MethodPathDescription
GET/Health check — confirms the server is running
GET/avlAVL section welcome message
POST/avl/node/addInsert a single obstacle into the AVL tree
POST/avl/node/removeRemove a single obstacle from the AVL tree
POST/avl/add/configsBulk-import a simulation config with multiple obstacles
GET/dataData section welcome message
GET/data/json/<filename>Read a JSON file from the server’s src/data/ folder

​
Detailed references

  • AVL endpoints — insert, remove, and bulk-configure obstacle nodes → AVL Endpoints
  • Data endpoints — read static JSON files from the backend → Data Endpoints

Build docs developers (and LLMs) love

Get started for freeTalk to us