FastAPI Documentation¶
Depictio uses FastAPI for its backend, which provides automatic, interactive API documentation. This page explains how to access and use this documentation.
Accessing the API Documentation¶
FastAPI automatically generates two types of interactive documentation:
- Swagger UI - Available at
/docs
- ReDoc - Available at
/redoc
To access these, simply append these paths to your Depictio API base URL:
- Swagger UI:
http://<your-depictio-host>:8058/docs
- ReDoc:
http://<your-depictio-host>:8058/redoc