ptarrant/Code_of_Conquest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update rate limit values to match config-based system

Browse Source 
- Update USAGE_TRACKING.md with new tier limits (50, 200, 1000, unlimited)
- Update AI_INTEGRATION.md with new tier limits
- Add note that limits are loaded from config (ai_calls_per_day)
- Document GET /api/v1/usage endpoint
- Update examples to show is_unlimited field
- Fix test examples with correct limit values

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Phillip Tarrant
2025-11-26 10:02:30 -06:00
parent 61a42d3a77
commit 19808dd44c
2 changed files with 44 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
api/docs/AI_INTEGRATION.md
View File

@@ -473,14 +473,18 @@ monthly = tracker.get_monthly_cost("user_123", 2025, 11)
Tier-based daily limits enforced via `app/services/rate_limiter_service.py`. Tier-based daily limits enforced via `app/services/rate_limiter_service.py`.
Limits are loaded from config (`rate_limiting.tiers.{tier}.ai_calls_per_day`).
### AI Calls (Turns) ### AI Calls (Turns)
| Tier | Daily Limit | | Tier | Daily Limit |
|------|------------| |------|------------|
| FREE | 20 turns | | FREE | 50 turns |
| BASIC | 50 turns | | BASIC | 200 turns |
| PREMIUM | 100 turns | | PREMIUM | 1000 turns |
| ELITE | 200 turns | | ELITE | Unlimited |
A value of `-1` in config means unlimited.
### Custom Actions ### Custom Actions

50
api/docs/USAGE_TRACKING.md
View File

@@ -270,14 +270,33 @@ class MonthlyUsageSummary:
### Daily Turn Limits ### Daily Turn Limits
Limits are loaded from config (`rate_limiting.tiers.{tier}.ai_calls_per_day`):
| Tier | Limit | Cost Level | | Tier | Limit | Cost Level |
|------|-------|------------| |------|-------|------------|
| FREE | 20 turns/day | Zero | | FREE | 50 turns/day | Zero |
| BASIC | 50 turns/day | Low | | BASIC | 200 turns/day | Low |
| PREMIUM | 100 turns/day | Medium | | PREMIUM | 1000 turns/day | Medium |
| ELITE | 200 turns/day | High | | ELITE | Unlimited | High |
Counters reset at midnight UTC. Counters reset at midnight UTC. A value of `-1` in config means unlimited.
### Usage API Endpoint
Get current usage info via `GET /api/v1/usage`:
```json
{
"user_id": "user_123",
"user_tier": "free",
"current_usage": 15,
"daily_limit": 50,
"remaining": 35,
"reset_time": "2025-11-27T00:00:00+00:00",
"is_limited": false,
"is_unlimited": false
}
```
### Custom Action Limits ### Custom Action Limits
@@ -342,14 +361,15 @@ info = limiter.get_usage_info("user_123", UserTier.PREMIUM)
# "user_id": "user_123", # "user_id": "user_123",
# "user_tier": "premium", # "user_tier": "premium",
# "current_usage": 45, # "current_usage": 45,
# "daily_limit": 100, # "daily_limit": 1000,
# "remaining": 55, # "remaining": 955,
# "reset_time": "2025-11-22T00:00:00+00:00", # "reset_time": "2025-11-22T00:00:00+00:00",
# "is_limited": False # "is_limited": False,
# "is_unlimited": False
# } # }
# Get limit for tier # Get limit for tier (-1 means unlimited)
limit = limiter.get_limit_for_tier(UserTier.ELITE) # 200 limit = limiter.get_limit_for_tier(UserTier.ELITE) # -1 (unlimited)
``` ```
### Admin Functions ### Admin Functions
@@ -539,9 +559,11 @@ When rate limited, prompt upgrades:
```python ```python
if e.user_tier == UserTier.FREE: if e.user_tier == UserTier.FREE:
message = "Upgrade to Basic for 50 turns/day!" message = "Upgrade to Basic for 200 turns/day!"
elif e.user_tier == UserTier.BASIC: elif e.user_tier == UserTier.BASIC:
message = "Upgrade to Premium for 100 turns/day!" message = "Upgrade to Premium for 1000 turns/day!"
elif e.user_tier == UserTier.PREMIUM:
message = "Upgrade to Elite for unlimited turns!"
``` ```
--- ---
@@ -585,8 +607,8 @@ def test_log_usage():
def test_rate_limit_exceeded(): def test_rate_limit_exceeded():
limiter = RateLimiterService() limiter = RateLimiterService()
# Exceed free tier limit # Exceed free tier limit (50 from config)
for _ in range(20): for _ in range(50):
limiter.increment_usage("test_user") limiter.increment_usage("test_user")
with pytest.raises(RateLimitExceeded): with pytest.raises(RateLimitExceeded):