Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

404 on Instance /docs URL. #250

Open
adamoutler opened this issue Oct 20, 2024 · 4 comments
Open

404 on Instance /docs URL. #250

adamoutler opened this issue Oct 20, 2024 · 4 comments

Comments

@adamoutler
Copy link

adamoutler commented Oct 20, 2024

According to docs.openwebui.com/api, I understand there should be documents at ai.my.com/docs, but all i see is a 404: Not Found. I'd expect to see documentation on Completion/Chat/Search APIs but I am not able to access it with ghcr.io/open-webui/open-webui:main as the instance.

@TheRealPSV
Copy link

This looks like the repo for the site docs, not the OpenAPI docs, so I think this issue should actually be posted over here in the main repo: https://github.com/open-webui/open-webui/issues

To answer your question though, it looks like the code is set up so you can't view the root /docs without a dev environment variable set up: https://github.com/open-webui/open-webui/blob/09935d191f34a35d81cc0fbd58b035e6e5068efc/backend/open_webui/main.py#L185

Since it looks like you're using a docker image, just pass the env var ENV=dev and it should work, although I don't know if this will have other unintended consequences.

@adamoutler
Copy link
Author

The docs say the API should be in the code without qualifications. Also the code provides all the other documentation endpoints by default. I don't see anything suggesting this is a documentation error. If there is a change in progress, it's an incomplete code and documentation issue. Otherwise it's a code issue.

@tjbck
Copy link
Contributor

tjbck commented Nov 6, 2024

ENV should be set to dev here to access the api documentations!

@adamoutler
Copy link
Author

Yes. That is the problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants