Documentation Index
Fetch the complete documentation index at: https://opencompress.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
API keys
All API requests require authentication via a Bearer token in theAuthorization header:
sk-occ- followed by a cryptographically random string.
Getting a key
- Sign in at opencompress.ai/dashboard
- Navigate to the API Keys section
- Click Create Key
- Choose a mode (Router or BYOK)
- Copy the key immediately — it’s shown only once
Key security
Best practices:- Store keys in environment variables, never in code
- Use different keys for development and production
- Revoke keys immediately if compromised
- Each key has independent rate limits and usage tracking
Key modes
| Mode | Description |
|---|---|
| Router | OpenCompress routes to the LLM via OpenRouter. You pay us for everything. |
| BYOK | Bring your own LLM key. You pay your provider directly; we charge only the compression fee. |
Key management
- Maximum keys: 5 active keys per account
- Revoke: Delete a key in the dashboard. Takes effect immediately.
- Last used: Dashboard shows when each key was last used