openwebui-anthropic / README.md
cotcotquedec's picture
docs(README): expand documentation for OpenWebUI Anthropic integration
736b42c
---
title: Openwebui Anthropic
emoji: πŸ“Š
colorFrom: blue
colorTo: gray
sdk: docker
app_port: 9099
pinned: false
short_description: Pipeline backend for using Claude model
---
# OpenWebUI Anthropic Integration πŸ€–
This space provides a backend service to use Anthropic's Claude models with OpenWebUI. It acts as an API compatibility layer between OpenWebUI and Anthropic's API.
## πŸ“‹ Overview
This service allows you to use Claude models in OpenWebUI by providing an OpenAI-compatible API endpoint. It supports all Claude 3 models:
- claude-3-opus-20240229
- claude-3-sonnet-20240229
- claude-3-haiku-20240307
- claude-3-5-sonnet-20241022
## πŸš€ Getting Started
### 1. Get Your Anthropic API Key
First, you'll need an Anthropic API key. You can get one from [Anthropic's website](https://console.anthropic.com/).
### 2. Configure OpenWebUI
In OpenWebUI's settings, add a new API endpoint with the following configuration:
1. Go to "Parameters" > "API compatibles OpenAI"
2. Set the API endpoint URL to:
```
https://cotcotquedec-openwebui-anthropic.hf.space
```
3. Add your Anthropic API key in the authorization field (as a Bearer token)
4. Save the configuration
The service will automatically fetch available models from:
```
https://cotcotquedec-openwebui-anthropic.hf.space/models
```
## πŸ”’ Security
- Your Anthropic API key is only used to authenticate requests to Anthropic's API
- The key is never stored or write anywhere
- All communication is encrypted via HTTPS
## 🌟 Features
- Compatible with OpenWebUI's interface
- Supports streaming responses
- Handles both chat completions and regular completions
- Automatic token management
## πŸ“ Usage Notes
- The service acts as a proxy between OpenWebUI and Anthropic's API
- Response formats are automatically converted to be compatible with OpenWebUI
- All Claude model features are supported (including system prompts)
## ⚠️ Limitations
- The service is designed specifically for OpenWebUI integration
- API calls require a valid Anthropic API key
- Usage is subject to Anthropic's rate limits and pricing
## πŸ”— Related Links
- [Anthropic API Documentation](https://docs.anthropic.com/claude/docs)
- [OpenWebUI Documentation](https://docs.openwebui.com/)
- [Hugging Face Spaces Documentation](https://huggingface.co/docs/hub/spaces)
## πŸ“„ License
This project is licensed under the MIT License - see the LICENSE file for details.
## ✨ Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
---
For more information about space configuration, check out the [Hugging Face Spaces configuration reference](https://huggingface.co/docs/hub/spaces-config-reference).