Scaleout Edge REST API
======================

This section documents the server-side REST API exposed by the Scaleout Edge
control plane. These endpoints are used by clients, combiners, and external
integrations to interact with the Scaleout Edge network. The API includes
operations for project management, training orchestration, model handling,
metrics, telemetry, and system-level metadata.

Authentication and Control
--------------------------
Endpoints related to authentication, authorization, and high-level control of the federated network.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: auth_routes.py, control_routes.py, attribute_routes.py

Clients and Combiners
---------------------
Endpoints for managing clients, combiners, and their runtime state in the federated network.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: client_routes.py, combiner_routes.py, status_routes.py

Sessions, Rounds, and Runs
--------------------------
Endpoints that control training sessions, orchestration rounds, and execution runs.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: session_routes.py, round_routes.py, run_routes.py

Models, Packages, and Predictions
---------------------------------
Endpoints for handling model artifacts, compute packages, predictions, and validation.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: model_routes.py, package_routes.py, prediction_routes.py, validation_routes.py

Metrics, Telemetry, and Helpers
-------------------------------
Endpoints for metrics, telemetry, and supporting helper operations.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: metric_routes.py, telemetry_routes.py, helper_routes.py

Large File Uploads
------------------
Endpoints for uploading large files using chunked uploads.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: upload_routes.py