From b48e7d9c7b326650dcd2c4f98487a4a2cbaae95c Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Sat, 23 Nov 2024 23:43:13 -0800 Subject: [PATCH] Update api-endpoints.md --- docs/getting-started/advanced-topics/api-endpoints.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/advanced-topics/api-endpoints.md b/docs/getting-started/advanced-topics/api-endpoints.md index 37dd185..d4fd3ed 100644 --- a/docs/getting-started/advanced-topics/api-endpoints.md +++ b/docs/getting-started/advanced-topics/api-endpoints.md @@ -185,6 +185,11 @@ Open WebUI offers a myriad of benefits, making it an essential tool for develope - **Ease of Implementation**: Quick start integration with comprehensive documentation and community support. ## Swagger Documentation Links + +:::important +Make sure to set the `ENV` environment variable to `dev` in order to access the Swagger documentation for any of these services. Without this configuration, the documentation will not be available. +::: + Access detailed API documentation for different services provided by Open WebUI: | Application | Documentation Path | @@ -199,4 +204,4 @@ Access detailed API documentation for different services provided by Open WebUI: Each documentation portal offers interactive examples, schema descriptions, and testing capabilities to enhance your understanding and ease of use. -By following these guidelines, you can swiftly integrate and begin utilizing the Open WebUI API. Should you encounter any issues or have questions, feel free to reach out through our Discord Community or consult the FAQs. Happy coding! 🌟 +By following these guidelines, you can swiftly integrate and begin utilizing the Open WebUI API. Should you encounter any issues or have questions, feel free to reach out through our Discord Community or consult the FAQs. Happy coding! 🌟 \ No newline at end of file