How to Add API Keys in ClariRec
Default System OCR needs no key. Add a key only for optional BYOK cloud OCR (Pro to run), cloud translation, or Pro formula recognition. Configuration and connection tests are free.
Steps
- Menu bar → Settings → Providers
- Open Text Recognition, Translation, or Formula Recognition
- Select a provider and fill the inline panel
- Test Connection → save / set as current engine
OCR and translation engines are independent. Shared keys (e.g. Custom API / Qwen) show as configured in every segment that uses them.
Provider matrix
| Provider | OCR | Translation | Formula (Pro) | Fields | Key console |
|---|---|---|---|---|---|
| Custom API | Yes | Yes | Yes | Key, Base URL, Model | Your compatible endpoint |
| Qwen | Yes | Yes | Yes | Key, optional Base URL | DashScope |
| Mistral AI | Yes | Yes | No | Key, optional Base URL | Mistral |
| Azure Document Intelligence | Yes | No | No | Key, Endpoint | Azure |
| Baidu OCR | Yes | No | No | Key, Secret Key | Baidu OCR |
| Google Cloud Vision | Yes | No | No | Key | Google Cloud |
| DeepL | No | Yes | No | Key, optional endpoint | DeepL |
| Mercury-2 | No | Yes | No | Key only | Inception Labs |
| OpenAI / Anthropic / DeepSeek / GLM / Grok / OpenRouter | No | Yes | No | Key only (built-in endpoint) | Respective provider consoles |
Built-in translation-only providers usually need only an API key. Consoles, models, and quotas change — use the provider’s current docs before buying credits.
Custom API: OpenAI-compatible chat endpoint. Vision-capable model required for OCR/formula; text model is enough for translation.
Formula (Pro): Configure Custom API or Qwen under Formula Recognition → unlock Pro → Test Formula. Billing is from your provider, not included in Pro.
Tencent OCR/TMT are not built-in providers today.
Privacy
Keys stay in macOS Keychain. Content goes only to the endpoint you configure when you use that provider. ClariRec does not relay it.
Troubleshooting
Test Connection fails
Check key, endpoint, quota, and region. For Azure/Baidu, fill the second field ClariRec asks for (Endpoint or Secret Key).
Cannot use this provider for translation
Azure, Baidu, and Google Vision are OCR-only. Use a translation provider or on-device / system translation.
Custom API saves but OCR/formula fails
Use an image-capable model and a Chat Completions-compatible endpoint. Formula also needs reliable structured JSON.
Related
FAQ · Local OCR · Translate · LaTeX · Privacy
