ADORe API
REST API for autonomous driving scenario management, model checking, data recording, and ROS2 system integration.
The ADORe REST API is automatically started with the ADORE CLI. There is no need to manually start it.
⚠️ SECURITY WARNING:
The ADORe API includes a REST interface that may allow remote code execution.
This system has not undergone a security audit and is intended for research purposes only.
Do not expose it to the public internet or run it on any publicly accessible system.
To disable the ADORe API modify the adore.env
file before launching the ADORE CLI
Quick Start
# Start the API server
cd tools/adore_api
python adore_api.py
# Check status
curl http://localhost:5000/api/status
Documentation
- 📖 API Reference - Complete endpoint documentation with request/response schemas
- 💻 cURL Examples - Ready-to-use command examples for all endpoints
Key Features
- Scenario Management - Start, stop, restart ROS2 launch scenarios
- Model Checking - Online safety verification with CTL model checker
- Data Recording - ROS bag recording with topic selection
- ROS2 Integration - Real-time topic subscription and publishing
- Position Management - Goal picker integration with coordinate conversion
Web Interface
Access the ADORe Mission Control interface at http://localhost:5000
for a complete web-based dashboard.
Base URL
http://localhost:5000/api