# DeepL Documentation ## Docs - [Get custom tag usage analytics](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/get-custom-tag-usage-analytics.md): Retrieve usage statistics broken down by custom tags within a specified date range. Optionally aggregate results by day or over the entire period. Results are paginated; use the `page` parameter with the `next_page` value from a previous response to retrieve subsequent pages. - [Get usage analytics](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/get-usage-analytics.md): Retrieve usage statistics for the organization within a specified date range. Optionally group the results by API key or by API key and day. - [Create a developer key](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/managing-developer-keys/create-key.md) - [Deactivate a developer key](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/managing-developer-keys/deactivate-key.md) - [Get developer keys](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/managing-developer-keys/get-keys.md) - [Rename a developer key](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/managing-developer-keys/rename-key.md) - [Set developer key limits](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/admin-api/managing-developer-keys/set-usage-limits.md) - [Detect Language](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/detect-language/detect-language-beta.md): Detect the language of text using DeepL's language detection service - [Check document status](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/document/check-document-status.md) - [Download translated document](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/document/download-translated-document.md) - [Upload and translate a document](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/document/upload-and-translate-a-document.md) - [Monolingual glossaries (v2 endpoints)](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries.md): Manage glossaries using the v2 endpoints - [Create a glossary](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/create-a-glossary.md) - [Delete a glossary](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/delete-a-glossary.md): Deletes the specified glossary. - [List all glossaries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/list-all-glossaries.md): List all glossaries and their meta-information, but not the glossary entries. - [Retrieve glossary details](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/retrieve-glossary-details.md): Retrieve meta information for a single glossary, omitting the glossary entries. - [Retrieve glossary entries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/retrieve-glossary-entries.md): List the entries of a single glossary in the format specified by the `Accept` header. - [v2 vs v3 endpoints](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/glossaries/v2-vs-v3-endpoints.md) - [Improve text](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/improve-text.md) - [Correct text](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/improve-text/correct-text.md): Fixes spelling and grammar errors with minimal changes to wording. - [Improve text](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/improve-text/request-text-improvement.md): Improves text by correcting spelling and grammar and rewriting for a target writing style or tone. - [Retrieve languages (v2)](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages.md): Reference for the deprecated v2/languages endpoint. Migrate to v3/languages for new integrations. - [Common use cases](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/language-feature-use-cases.md): Pseudocode examples for common language and feature lookup patterns using the v3/languages endpoints. - [Migrating from v2/languages](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/migrate-from-v2-languages.md): How to migrate from the v2/languages endpoint to the v3/languages endpoints. - [Retrieve languages](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/retrieve-languages-by-resource.md): Returns languages supported by the specified DeepL API resource. Each language indicates whether it can be used as a source language, a target language, or both, along with the features it supports for that resource. - [Retrieve language resources](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/retrieve-resources.md): Learn how to retrieve the list of DeepL API resources and their supported language features. - [Retrieve supported languages (v2)](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/retrieve-supported-languages.md): **Deprecated.** Use `GET /v3/languages?resource=translate_text` (or the appropriate resource) instead. See the [migration guide](https://developers.deepl.com/api-reference/languages/migrate-from-v2-languages) for details. - [Retrieve supported languages by resource](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/retrieve-supported-languages-by-resource.md): Learn how to retrieve supported language and feature data across all DeepL API resources - [v3/languages changelog](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/languages/v3-languages-changelog.md): Changes to the v3/languages endpoints, including the GA release and prior breaking changes. - [Glossaries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries.md): Manage and use DeepL glossaries - [Create a glossary](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/create-a-glossary.md) - [Delete a glossary](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/delete-a-glossary.md): Deletes the specified glossary. - [Deletes the dictionary associated with the given language pair with the given glossary ID.](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/deletes-the-dictionary-associated-with-the-given-language-pair-with-the-given-glossary-id.md) - [Edit glossary details](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/edit-glossary-details.md): Edit glossary details, such as name or a dictionary for a source and target language. - [List all glossaries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/list-all-glossaries.md): List all glossaries and their meta-information, but not the glossary entries. - [List language pairs supported for glossaries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/list-language-pairs-supported-by-glossaries.md): **Deprecated.** Use `GET /v3/languages?resource=glossary` instead, which returns per-language availability including source and target roles. - [Replaces or creates a dictionary in the glossary with the specified entries.](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/replaces-or-creates-a-dictionary-in-the-glossary-with-the-specified-entries.md) - [Retrieve glossary details](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/retrieve-glossary-details.md): Retrieve meta information for a single glossary, omitting the glossary entries. - [Retrieve glossary entries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/multilingual-glossaries/retrieve-glossary-entries.md): List the entries of a single glossary in tsv format. - [Style rules](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules.md): Manage a shared list of rules for style, formatting, and more - [Create a custom instruction](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/create-custom-instruction.md) - [Create a style rule list](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/create-style-rule.md) - [Delete a custom instruction](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/delete-custom-instruction.md) - [Delete a style rule list](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/delete-style-rule.md) - [Get a custom instruction](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/get-custom-instruction.md) - [Get a style rule list](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/get-style-rule.md) - [Get all style rule lists](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/list-all-style-rules.md) - [Replace configured rules](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/update-configured-rules.md) - [Replace a custom instruction](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/update-custom-instruction.md) - [Update a style rule list's name](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/style-rules/update-style-rule.md) - [Translate text](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/translate/request-translation.md) - [List translation memories](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/translation-memory/list-translation-memories.md): Retrieve translation memories associated with your account, used to store and reuse previously created translations. See [How to use translation memories](/docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories) to use them in translation requests. - [Check usage and limits](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/usage-and-quota/check-usage-and-limits.md): Retrieve near-real-time character usage and account limits for the current billing period. - [Reconnect Session](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/voice/reconnect-session.md) - [Request Session](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/voice/request-session.md) - [WebSocket Streaming](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/voice/websocket-streaming.md): WebSocket channel for streaming audio and receiving transcriptions and translations. Messages are exchanged in JSON or MessagePack format. WebSocket messages are exchanged in TEXT frames when using JSON format and in BINARY frames when using MessagePack format. Sending the wrong frame type will resu… - [Understanding API Key Permissions](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/api-key-permissions.md): Why scoped API keys exist, how DeepL enforces permission scopes, and when to choose a scoped key over an unrestricted one. - [Managing API Keys in the Account UI](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/managing-api-keys.md): Create, rename, deactivate, and set usage limits and permissions on DeepL API keys in the account UI. - [Admin](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/overview.md): Manage API keys, control what each key can access, and monitor usage across your organization, from the account UI or programmatically with the Admin API. - [Permission Scopes](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/permission-scopes.md): Every permission scope for DeepL developer API keys and the endpoints each scope covers. - [Admin API Quickstart](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/quickstart.md): Create a developer API key, set a usage limit on it, and pull a per-key usage report in four calls to the Admin API. - [Retrieving Usage Data](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/admin/retrieving-usage-data.md): Compare DeepL's usage data sources and pull character and minute consumption for your account, API keys, or custom tags. - [CORS requests](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/cors-requests.md) - [Subscription-level cost control](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/cost-control.md) - [Custom instructions](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/custom-instructions.md): Learn how to create effective custom instructions to customize your translation behavior - [Document translations](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/document-translations.md) - [Error handling](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/error-handling.md) - [Estimating Character Usage](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/estimating-character-usage.md): Learn how to estimate your DeepL API character usage to find the right plan. - [Language detection](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/language-detection.md) - [Pre-production checklist](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/best-practices/pre-production-checklist.md): Here's what we recommend reviewing to get your DeepL API application ready for production. - [About](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/about.md) - [SDKs](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/client-libraries.md): Using your favorite programming language with the DeepL API - [DeepL CLI](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/deepl-cli.md): Install and use the DeepL CLI to translate text, documents, and more from your terminal. - [DeepL MCP Server](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/deepl-mcp-server.md): Use the DeepL MCP Server to add translation capabilities to Claude, Cursor, and other AI agents. - [Docs MCP Server](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/docs-mcp-server.md): Connect your AI tools to the DeepL developer documentation for source-grounded answers about the DeepL API. - [Quickstart](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/quickstart.md) - [Regional API Endpoints](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/regional-endpoints.md): Reference documentation for DeepL's regional API endpoints, including endpoint URLs, configuration, and technical specifications. - [Languages supported](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/supported-languages.md): The DeepL API supports the following languages. - [Postman](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/getting-started/test-your-api-requests-with-postman.md): Use our official Postman collection to get familiar with and test the DeepL API. - [API Usage Logger](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/api-usage-logger.md): Learn how to capture per-request DeepL API usage data and visualize it in a local dashboard. - [Automating Indie Game Localization with the DeepL API and Godot](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot.md): Efficiently translate content for a global audience and widen your game's reach - [Project: Google Sheets](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/google-sheets.md): Open-source example showing how to build a Google Sheets App using the DeepL API. - [Building a Document Translator with the DeepL API](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/java-document-translator.md): Streamline document localization workflows with automated translation for businesses and developers - [Making API calls from client-side JavaScript](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/nodejs-proxy.md): Two lightweight local proxies that let you try the DeepL API directly from a website - [Sending Custom Reporting Tags with Client Libraries](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/sending-custom-reporting-tags-from-client-libraries.md): Code snippets for attaching X-DeepL-Reporting-Tag to translate requests using the official DeepL client libraries. - [Usage Analytics Dashboard](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/cookbook/usage-analytics-dashboard.md): A demo dashboard for visualizing DeepL API key usage across an entire account using the Admin API. - [How to Apply Customizations to Language Variants](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/customizations-for-variants.md): Learn how to apply glossaries and style rules when translating into language variants like FR-CA or EN-GB. - [DeepL MCP Server: How to build and use translation in LLM applications](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/deepl-mcp-server-how-to-build-and-use-translation-in-llm-applications.md): Efficiently translate content with AI-powered translation and enhance your interactions with large language models. - [Glossaries in the real world](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world.md): A quick guide to using DeepL glossaries in translations - [How to Use the Context Parameter Effectively](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter.md): Learn when and how to use the context parameter to improve translation accuracy for ambiguous content. - [How to Use Custom Reporting Tags](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/how-to-use-custom-reporting-tags.md): Learn how to attach reporting tags to translate requests so you can break down usage by team, project, or category. - [Translate text using a translation memory](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories.md): Learn how to retrieve your translation memories and use them in translation requests - [Mustache placeholder tags](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/placeholder-tags.md): An example for working with placeholder tags—in this case, Mustache tags. - [How to Translate Between Language Variants](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/learning-how-tos/examples-and-guides/translating-between-variants.md): Learn how to translate between language variants, like British English and US English, using the DeepL API. - [Alpha and beta features](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/alpha-and-beta-features.md): Learn more about alpha and beta features in the DeepL API and how to best make use of them. - [API Status Page](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/api-status-page.md): Monitor the operational status and availability of the DeepL API - [Breaking changes (Change Notices)](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/breaking-changes-change-notices.md) - [July 2024: Deprecation of insecure cipher suites](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/breaking-changes-change-notices/july-2024-deprecation-of-insecure-cipher-suites.md) - [March 2025: Deprecating GET requests to /translate and authenticating with auth_key](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/breaking-changes-change-notices/march-2025-deprecating-get-requests-to-translate-and-authenticating-with-auth_key.md) - [November 2025: Deprecation of query parameter and request body authentication](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/breaking-changes-change-notices/november-2025-deprecation-of-legacy-auth-methods.md) - [Developer Community](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/deepl-developer-community.md) - [Language release process](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/language-release-process.md): Here's what API users can expect when DeepL adds translation support for a new language or language variant. - [OpenAPI spec](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/open-api-spec.md): Download the OpenAPI specification for the DeepL API - [Changelog](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/roadmap-and-release-notes.md): The latest features and improvements in the DeepL API, plus what's coming next - [Usage and limits](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/resources/usage-limits.md) - [Translate](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/overview.md): Translate text strings and complete documents with the DeepL API. Find quickstarts, markup handling guides, and customization options. - [Translate Documents Quickstart](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/translate-documents-quickstart.md): Upload a Word document to the DeepL API, poll its translation status, and download the translated file, in three curl calls or one client library call. - [Translate Text Quickstart](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/translate-text-quickstart.md): Send your first text translation request to the DeepL API and batch multiple strings into a single call. - [Translating HTML](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/translating-html.md): Learn how to translate HTML content with the DeepL API and exclude specific elements from translation. - [Translating Large Volumes of Text](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/translating-large-volumes.md): Batch texts, control sentence splitting, and parallelize requests to translate high volumes efficiently with the text translation endpoint. - [Translating XML](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/translating-xml.md): Learn how to translate XML content with the DeepL API while preserving its structure, and how to control sentence splitting. - [Understanding Model Types](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/translate/understanding-model-types.md): How the model_type parameter chooses between latency-optimized and quality-optimized translation models, and how DeepL selects the model for each request. - [Message Encoding](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/voice/message-encoding.md): Choose between JSON and MessagePack encoding for DeepL Voice API WebSocket messages, and avoid the frame type and map encoding pitfalls. - [DeepL Voice API](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/voice/overview.md): Transcribe and translate spoken audio in real time with the DeepL Voice API. Find the streaming guide, core concepts, and language and format reference. - [Real-Time Voice Quickstart](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/voice/real-time-voice-quickstart.md): Stream microphone audio to the DeepL Voice API from Python and print live translations to your terminal as the speaker talks. - [Supported Languages, Formats, and Limits](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/voice/supported-languages-formats-and-limits.md): Reference for DeepL Voice API language availability, supported audio codecs and containers, and session limits. - [Understanding Voice Sessions](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/docs/voice/understanding-voice-sessions.md): Understand the lifecycle of a DeepL Voice API session: how connections are established, how tokens secure reconnection, and how audio and results flow. ## OpenAPI Specs - [openapi](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/openapi.yaml) ## AsyncAPI Specs - [voice.asyncapi](https://deepl-c950b784-docs-language-table-from-v3.mintlify.app/api-reference/voice/voice.asyncapi.yaml)