Skip to content

docs: clarify API key requirements and simplify structure #13

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.

Sign up for GitHub

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

Merged
oscarvalenzuelab merged 1 commit into from
Apr 3, 2026
Merged

docs: clarify API key requirements and simplify structure #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading