From db947a381ff2ee0c94020087c709be5346b0dd29 Mon Sep 17 00:00:00 2001 From: Oscar V Date: Fri, 3 Apr 2026 12:03:02 -0700 Subject: [PATCH] docs: clarify API key requirements and simplify structure - Clarify API keys are free and require `check` scope - Move "Getting an API Key" section right after API Modes - Simplify API modes table (remove URL column, focus on use case) --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 69c01c3..e95f142 100644 --- a/README.md +++ b/README.md @@ -47,29 +47,31 @@ else: ## API Modes -| Mode | URL | Use Case | -|------|-----|----------| -| **Proxy** | `http://localhost:8080` | Self-hosted, lower latency | -| **Cloud** | `https://aiproxyguard.com` | Managed service, no infrastructure | +The SDK supports two ways to use AIProxyGuard: + +| Mode | Use Case | +|------|----------| +| **Self-hosted proxy** | Deploy your own proxy (free), no API key required | +| **Cloud API** | Managed service at `aiproxyguard.com`, requires free API key | ```python -# Self-hosted proxy +# Self-hosted proxy - no API key required client = AIProxyGuard("http://localhost:8080") -# Cloud API (requires API key) +# Cloud API - managed service (requires free API key) client = AIProxyGuard( "https://aiproxyguard.com", api_key="apg_your_api_key_here" ) ``` -### Getting an API Key +### Getting an API Key (Cloud Mode) -You can get an API key on [aiproxyguard.com](https://aiproxyguard.com): +API keys are **free**. To use the cloud API: -1. Sign up or log in at [aiproxyguard.com](https://aiproxyguard.com) -2. Navigate to **Settings** → **API Keys** -3. Click **Create API Key** +1. Sign up at [aiproxyguard.com](https://aiproxyguard.com) +2. Go to **Settings** → **API Keys** → **Create API Key** +3. **Enable the `check` scope** in permissions 4. Copy your key (starts with `apg_`) ## Usage