API Reference
Authentication
Most API requests require authentication. Tallyify supports two methods: API keys for server-side integrations and session cookies for browser-based dashboard access. The public catalog endpoints (/models, /compare) need no credentials; write, watchlist and account endpoints require an API key (or a signed-in session).
API Key Authentication
Use your API key in the Authorization header:
Getting an API Key
- Go to Dashboard - Settings - API Keys
- Click Create API Key
- Enter a descriptive name, such as
Production Server - Copy the key. It is shown only once.
Security: Tallyify API keys authenticate your usage telemetry. Store them in environment variables and never commit them to source control.
API Key Scopes
API keys can be scoped for telemetry, usage, pricing and alert workflows. The default SDK key uses track:write.
Access Levels
| Plan | API Access | Keys Limit | History |
|---|---|---|---|
| Free | SDK tracking | 1 key | 7 days |
| Pro | SDK tracking | 3 keys | Full history |
| Team | Limited API + SDK | 10 keys | Full history |
| Enterprise | Full API + SDK | 100 keys | Unlimited |
Rate Limits
The telemetry ingestion endpoint is rate limited per API key. Other endpoints are governed by fair-use and your plan limits rather than a fixed per-minute quota.
| Endpoint | Limit | Window |
|---|---|---|
POST /v1/track | 600 req/min per key (configurable) | 1 minute |
| Other endpoints | Fair use | — |
Exceeding the track limit returns 429 with { "error": "Rate limit exceeded" }.
Authentication Errors
Best Practices
- Store API keys in environment variables (
process.env.TALLYIFY_API_KEY) - Use separate keys per environment, such as development, staging and production
- Rotate keys regularly and revoke old ones from the dashboard
- Never log API keys, even partially