API reference documentation for cloud and local providers integrated into AriaType.
- Read
../README.mdfor document routing and canonical sources - Read
../guides/for step-by-step integration or debugging workflows - Read
../spec/engine-api-contract.mdfor contract-testing policy and engine-level interface rules - Read this directory when you need provider facts: endpoints, auth methods, models, limits, or request shapes
This directory contains stable API reference documentation for external providers. These docs support implementation and debugging; they are not plans or strategy documents.
| Category | Document | Description |
|---|---|---|
| STT (Speech-to-Text) | providers/stt.md | All STT providers: Volcengine, OpenAI, Deepgram, ElevenLabs, Qwen Omni, Custom Endpoint |
| Local STT Models | providers/local-stt-models.md | Local STT model research: SenseVoice, Whisper, Distil-Whisper, Parakeet TDT, Moonshine, Qwen3-ASR, Paraformer, FireRedAsr comparison |
| Polish (Text Enhancement) | providers/polish.md | All text polishing providers: Anthropic, OpenAI, Qwen, Custom Endpoint |
| Polish Latency Case Study | providers/capswriter-polish-latency.md | CapsWriter-Offline polish latency analysis and AriaType architecture recommendations |
| Want to... | Go to... |
|---|---|
| Understand engine API contracts | spec/engine-api-contract.md |
| Add a new STT provider | guides/adding-stt-provider.md |
| Add a new Polish provider | guides/adding-polish-provider.md |
| Look up provider-specific API details | providers/ |
| Compare local STT models for sherpa-onnx | providers/local-stt-models.md |
| Understand why CapsWriter-Offline polish feels fast | providers/capswriter-polish-latency.md |
| Understand provider selection logic | architecture/data-flow.md |
- Update provider docs when API contracts change or new providers are added
- Verify provider URLs and authentication methods against actual provider documentation
- Keep feature comparison tables current with implemented functionality