mirror of
https://github.com/eigent-ai/eigent.git
synced 2026-05-29 19:15:39 +00:00
9a9d008bb6
Some checks failed
Pre-commit / pre-commit (push) Has been cancelled
Test / Run Python Tests (push) Has been cancelled
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Co-authored-by: Tao Sun <168447269+fengju0213@users.noreply.github.com> Co-authored-by: Sun Tao <2605127667@qq.com>
89 lines
6.3 KiB
Markdown
89 lines
6.3 KiB
Markdown
---
|
|
title: Bring Your Own Key (BYOK)
|
|
description: Configure your own API keys to use various LLM providers with Eigent.
|
|
---
|
|
|
|
## What is BYOK?
|
|
|
|
**Bring Your Own Key (BYOK)** allows you to use your own API keys from various AI model providers with Eigent. Instead of relying on a shared service, you connect directly to providers like OpenAI, Anthropic, or Google using your personal API credentials. This gives you:
|
|
|
|
- **Full control** over your API usage and billing
|
|
- **Direct access** to the latest models from each provider
|
|
- **Privacy** - your requests go directly to the provider
|
|
|
|
## OpenAI Configuration (Example)
|
|
|
|
### Step 1: Get Your API Key
|
|
|
|
1. Visit the [OpenAI API Keys page](https://platform.openai.com/api-keys)
|
|
1. Click **"Create new secret key"**
|
|
1. Copy the generated key (you won't be able to see it again)
|
|
|
|
### Step 2: Configure in Eigent
|
|
|
|
1. Launch Eigent and go to **Agent** > **Models**
|
|
|
|
1. Find the **OpenAI** card in the Custom Model section
|
|
|
|
|
|
|
|
1. Fill in the following fields:
|
|
|
|
| Field | Value | Example |
|
|
| -------------- | ------------------------- | --------------------------- |
|
|
| **API Key** | Your OpenAI secret key | `sk-proj-xxxx...` |
|
|
| **API Host** | OpenAI API endpoint | `https://api.openai.com/v1` |
|
|
| **Model Type** | The model you want to use | `gpt-4o`, `gpt-4o-mini` |
|
|
|
|
4. Click **Save** to validate and store your configuration
|
|
1. Click **Set as Default** to use this provider for your agents
|
|
|
|
## Configuration Fields
|
|
|
|
| Field | Description | Required |
|
|
| ------------------- | -------------------------------------------------------- | ----------------------------------- |
|
|
| **API Key** | Your authentication key from the provider | Yes |
|
|
| **API Host** | The API endpoint URL | Yes (pre-filled for most providers) |
|
|
| **Model Type** | The specific model variant to use | Yes |
|
|
| **External Config** | Provider-specific settings (e.g., Azure deployment name) | Only for certain providers |
|
|
|
|
### Azure-Specific Fields
|
|
|
|
| Field | Description | Example |
|
|
| ------------------- | -------------------------- | -------------------- |
|
|
| **API Version** | Azure OpenAI API version | `2024-02-15-preview` |
|
|
| **Deployment Name** | Your Azure deployment name | `my-gpt4-deployment` |
|
|
|
|
## Common Errors
|
|
|
|
When saving your configuration, Eigent validates your API key and model. Here are the errors you may encounter:
|
|
|
|
| Error | Cause | Solution |
|
|
| ------------------------------------------ | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
| **Invalid key. Validation failed.** | API key is incorrect, expired, or malformed | Double-check your API key. Regenerate a new key if needed. |
|
|
| **Invalid model name. Validation failed.** | The specified model does not exist or is not available for your account | Verify the model name is correct. Check if you have access to that model. |
|
|
| **You exceeded your current quota** | API quota exhausted or billing issue | Check your provider's billing dashboard. Add credits or upgrade your plan. |
|
|
|
|
## Supported Providers
|
|
|
|
Eigent supports the following BYOK providers:
|
|
|
|
| Provider | Default API Host | Official Documentation |
|
|
| --------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
| **OpenAI** | `https://api.openai.com/v1` | [OpenAI API Docs](https://platform.openai.com/docs/api-reference) |
|
|
| **Anthropic** | `https://api.anthropic.com/` | [Anthropic API Docs](https://docs.anthropic.com/en/api/getting-started) |
|
|
| **Google Gemini** | `https://generativelanguage.googleapis.com/v1beta/openai/` | [Gemini API Docs](https://ai.google.dev/gemini-api/docs) |
|
|
| **OpenRouter** | `https://openrouter.ai/api/v1` | [OpenRouter Docs](https://openrouter.ai/docs) |
|
|
| **Qwen (Alibaba)** | `https://dashscope.aliyuncs.com/compatible-mode/v1` | [Qwen API Docs](https://help.aliyun.com/zh/dashscope/developer-reference/api-details) |
|
|
| **DeepSeek** | `https://api.deepseek.com` | [DeepSeek API Docs](https://platform.deepseek.com/api-docs) |
|
|
| **Minimax** | `https://api.minimax.io/v1` | [Minimax API Docs](https://platform.minimaxi.com/document/Announcement) |
|
|
| **Z.ai** | `https://api.z.ai/api/coding/paas/v4/` | [Z.ai Platform](https://z.ai) |
|
|
| **Azure OpenAI** | _(user-provided)_ | [Azure OpenAI Docs](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) |
|
|
| **AWS Bedrock** | _(user-provided)_ | [AWS Bedrock Docs](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html) |
|
|
| **OpenAI Compatible** | _(user-provided)_ | For custom endpoints (e.g., xAI, local servers) |
|
|
|
|
## Tips
|
|
|
|
- **Keep your API key secure** - Never share or expose your API key publicly
|
|
- **Monitor usage** - Check your provider's dashboard regularly to track costs
|
|
- **Use appropriate models** - Different models have different capabilities and pricing
|