How deepl/api-docs works
This repository is DeepL’s developer documentation and its authoritative REST and voice API specifications. The main user journey is a developer finding a capability guide or API reference, then using the corresponding DeepL API. The docs cover text and document translation, voice, language detection, writing improvement, and customization resources. The tree and README establish these content areas; sampled code also supports a language-table UI and account-aware site personalization. Documentation content describes API behavior—it does not itself execute translations. Some subsystem links are omitted because their implementation was not sampled.
Main entry points: docs.json Docs portal · api-reference API reference · language-table.jsx Language table · user-data.js Client state
Components 21
Developer guides
- Getting started
docs/getting-started - Translation guides
docs/translate - Voice guides
docs/voice - Customization guides
docs/customize - Language guides
docs/languages - Admin guides
docs/admin
API reference
- API reference
api-reference - Text translation
api-reference/translate - Document translation
api-reference/document - Voice API
api-reference/voice - Languages
api-reference/languages - Text improvement
api-reference/improve-text - Customization APIs
api-reference/glossaries - Admin APIs
api-reference/admin-api
API specifications
- REST specification
api-reference/openapi.yaml - Voice specification
api-reference/voice/voice.asyncapi.yaml
Documentation site
- Docs portal
docs.json - Language table
snippets/language-table.jsx - Client state
user-data.js
Other components
- Developer
- DeepL web service
Connections 21
- Developer → Docs portal: opens
- Docs portal → Getting started: navigates
- Docs portal → Translation guides: navigates
- Docs portal → Voice guides: navigates
- Docs portal → Customization guides: navigates
- Docs portal → Language guides: navigates
- Docs portal → Admin guides: navigates
- Docs portal → API reference: navigates
- API reference → Text translation: documents
- API reference → Document translation: documents
- API reference → Voice API: documents
- API reference → Languages: documents
- API reference → Text improvement: documents
- API reference → Customization APIs: documents
- API reference → Admin APIs: documents
- REST specification → API reference: specifies REST
- Voice specification → Voice API: specifies streaming
- Docs portal → Language table: renders snippet
- Language table → Languages: links language docs
- Docs portal → Client state: loads personalization
- Client state → DeepL web service: fetches client state