Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .mintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
reviews/*
api-reference/openapi.json
api-reference/voice/voice.asyncapi.json
1 change: 1 addition & 0 deletions api-reference/admin-api/get-custom-tag-usage-analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: get /v2/admin/analytics/custom-tags
title: "Get custom tag usage analytics"
description: "Retrieve DeepL API usage broken down by custom tag for a date range, optionally aggregated by day, with paginated results."
---

## Date range
Expand Down
1 change: 1 addition & 0 deletions api-reference/admin-api/get-usage-analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: get /v2/admin/analytics
title: "Get usage analytics"
description: "Retrieve organization-wide DeepL API usage for a date range, optionally grouped by API key or by API key and day."
---

## Date range
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v2/admin/developer-keys
title: "Create a developer key"
description: "Create a new DeepL API key for your organization as an admin, using the Admin API."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: put /v2/admin/developer-keys/deactivate
title: "Deactivate a developer key"
description: "Deactivate a DeepL API key as an admin so it can no longer be used to authenticate requests."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v2/admin/developer-keys
title: "Get developer keys"
description: "List every DeepL API key in your organization as an admin, including each key's label and usage limits."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: put /v2/admin/developer-keys/label
title: "Rename a developer key"
description: "Change the label on an existing DeepL API key as an admin, using the Admin API."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: put /v2/admin/developer-keys/limits
title: "Set developer key limits"
description: "Set or update the usage limit on an individual DeepL API key as an admin."
---
1 change: 1 addition & 0 deletions api-reference/document/check-document-status.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v2/document/{document_id}
title: "Check document status"
description: "Check whether an uploaded document has finished translating, along with its billed character count and any error."
---
1 change: 1 addition & 0 deletions api-reference/document/download-translated-document.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v2/document/{document_id}/result
title: "Download translated document"
description: "Download the translated file once a document translation job has finished. Results are available for a limited time."
---
1 change: 1 addition & 0 deletions api-reference/document/upload-and-translate-a-document.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v2/document
title: "Upload and translate a document"
description: "Upload a document for translation and receive the document ID and key needed to check status and download the result."
---
1 change: 1 addition & 0 deletions api-reference/glossaries/create-a-glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: post /v2/glossaries
title: "Create a glossary"
description: "Create a v2 glossary from a list of source and target term pairs for a single language pair."
playground: none
---
1 change: 1 addition & 0 deletions api-reference/glossaries/delete-a-glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: delete /v2/glossaries/{glossary_id}
title: "Delete a glossary"
description: "Delete a v2 glossary and all of its entries. Deleted glossaries cannot be recovered."
playground: none
---
1 change: 1 addition & 0 deletions api-reference/glossaries/list-all-glossaries.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: get /v2/glossaries
title: "List all glossaries"
description: "List every v2 glossary on your account with its metadata, without returning the glossary entries."
playground: none
---
1 change: 1 addition & 0 deletions api-reference/glossaries/retrieve-glossary-details.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: get /v2/glossaries/{glossary_id}
title: "Retrieve glossary details"
description: "Retrieve the metadata for a single v2 glossary, including its language pair and entry count, without the entries."
playground: none
---
1 change: 1 addition & 0 deletions api-reference/glossaries/retrieve-glossary-entries.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: get /v2/glossaries/{glossary_id}/entries
title: "Retrieve glossary entries"
description: "Retrieve the term pairs stored in a single v2 glossary, in the format requested through the Accept header."
playground: none
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "DeepL Write API Service Specification Updates"
description: "Service specification terms for the DeepL Write text improvement function, available on DeepL API Pro subscriptions."
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v1/jobs/voice/translate
title: "Create a voice translation job"
description: "Create an asynchronous voice translation job and receive an upload URL for your source audio file."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/jobs/voice/translate/{job_id}
title: "Get voice translation job status"
description: "Check the status of a voice translation job and get a download URL and signature for each completed target."
---
1 change: 1 addition & 0 deletions api-reference/languages/retrieve-languages-by-resource.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
openapi: get /v3/languages
title: "Retrieve languages"
description: "Retrieve the languages a DeepL API resource supports, including source and target roles and per-resource features."
---

1 change: 1 addition & 0 deletions api-reference/languages/retrieve-supported-languages.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: get /v2/languages
title: "Retrieve supported languages (v2)"
description: "Reference for the deprecated v2/languages endpoint. New integrations should use the v3/languages endpoints instead."
tag: "DEPRECATED"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v3/glossaries
title: "Create a glossary"
description: "Create a v3 multilingual glossary holding one or more dictionaries, each covering a source and target language pair."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: delete /v3/glossaries/{glossary_id}
title: "Delete a glossary"
description: "Delete a v3 multilingual glossary along with all of its dictionaries and entries. This cannot be undone."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Delete a single dictionary from a v3 multilingual glossary by its source and target language pair."
openapi: delete /v3/glossaries/{glossary_id}/dictionaries
sidebarTitle: Delete a glossary dictionary
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
description: "Rename a v3 multilingual glossary, or edit the dictionary for one source and target language pair."
openapi: patch /v3/glossaries/{glossary_id}
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/glossaries
title: "List all glossaries"
description: "List every v3 multilingual glossary on your account with its metadata, without returning the entries."
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: "get /v2/glossary-language-pairs"
title: "List language pairs supported for glossaries"
description: "Reference for the deprecated v2/glossary-language-pairs endpoint. New integrations should use v3/languages instead."
tag: "DEPRECATED"
playground: none
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
description: "Create a dictionary in a v3 multilingual glossary, or replace the entries in an existing one, for one language pair."
openapi: put /v3/glossaries/{glossary_id}/dictionaries
sidebarTitle: "Create or replace glossary entries"
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/glossaries/{glossary_id}
title: "Retrieve glossary details"
description: "Retrieve the metadata for a single v3 multilingual glossary, including its dictionaries, without the entries."
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/glossaries/{glossary_id}/entries
title: "Retrieve glossary entries"
description: "Retrieve the term pairs stored in a v3 multilingual glossary dictionary, returned in TSV format."
---
1 change: 1 addition & 0 deletions api-reference/quality-evaluation/poll.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: get /v1/quality-evaluation/{job_id}
title: "Poll for the evaluation result"
description: "Poll an evaluation job for its status, and retrieve the full quality evaluation report once the job completes."
---

See the [Quality Evaluation overview](/api-reference/quality-evaluation) for severity values, sub-types, span semantics, and limits.
Expand Down
1 change: 1 addition & 0 deletions api-reference/quality-evaluation/submit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: post /v1/quality-evaluation
title: "Submit an evaluation job"
description: "Submit translated segments for quality evaluation and receive a poll URL for retrieving the report."
---

See the [Quality Evaluation overview](/api-reference/quality-evaluation) for severity values, sub-types, span semantics, and limits.
Expand Down
1 change: 1 addition & 0 deletions api-reference/style-rules/create-custom-instruction.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v3/style_rules/{style_id}/custom_instructions
title: "Create a custom instruction"
description: "Add a custom instruction to a style rule list to shape translation output beyond the configured rules."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/create-style-rule.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v3/style_rules
title: "Create a style rule list"
description: "Create a style rule list, the container for the configured rules and custom instructions applied to translations."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/delete-custom-instruction.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: delete /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
title: "Delete a custom instruction"
description: "Remove a single custom instruction from a style rule list, leaving its configured rules in place."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/delete-style-rule.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: delete /v3/style_rules/{style_id}
title: "Delete a style rule list"
description: "Delete a style rule list along with its configured rules and custom instructions."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/get-custom-instruction.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
title: "Get a custom instruction"
description: "Retrieve a single custom instruction from a style rule list by its instruction ID."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/get-style-rule.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/style_rules/{style_id}
title: "Get a style rule list"
description: "Retrieve a single style rule list, including its configured rules and custom instructions."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/list-all-style-rules.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/style_rules
title: "Get all style rule lists"
description: "List every style rule list on your account, with the configured rules and custom instructions on each."
---
2 changes: 1 addition & 1 deletion api-reference/style-rules/request-translation.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: /api-reference/style-rules/openapi-temp.yaml post /v2/translate
title: "Translate text"
description: ""
description: "Translate text with a style rule list applied, using the style_id parameter on the translate endpoint."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/update-configured-rules.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: put /v3/style_rules/{style_id}/configured_rules
title: "Replace configured rules"
description: "Replace the full set of configured rules on a style rule list. Rules left out of the request are removed."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/update-custom-instruction.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: put /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
title: "Replace a custom instruction"
description: "Replace the text of an existing custom instruction on a style rule list."
---
1 change: 1 addition & 0 deletions api-reference/style-rules/update-style-rule.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: patch /v3/style_rules/{style_id}
title: "Update a style rule list's name"
description: "Rename an existing style rule list without changing its configured rules or custom instructions."
---
2 changes: 1 addition & 1 deletion api-reference/translate/request-translation.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: post /v2/translate
title: "Translate text"
description: ""
description: "Translate text between any supported language pair, with options for formality, glossaries, tag handling, and context."
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
openapi: get /v3/translation_memories
title: "List translation memories"
description: "Retrieve translation memories associated with your account, used to store and reuse previously created translations. See [How to use translation memories](/docs/customize/using-translation-memories) to use them in translation requests."
description: "Retrieve the translation memories on your account, which store previously created translations for reuse."
---

To apply a translation memory to a translation request, see [Using translation memories](/docs/customize/using-translation-memories).
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "DeepL Voice API Service Specification Updates"
description: "Service specification terms for the DeepL Voice API, including how audio minutes are defined and measured."
---


Expand Down
1 change: 1 addition & 0 deletions api-reference/voice/reconnect-session.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v3/voice/realtime
title: "Reconnect Session"
description: "Reconnect to an interrupted real-time voice translation session and resume streaming audio."
---
1 change: 1 addition & 0 deletions api-reference/voice/request-session.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v3/voice/realtime
title: "Request Session"
description: "Request a real-time voice translation session and receive the WebSocket streaming URL to connect to."
---
1 change: 1 addition & 0 deletions api-reference/voice/websocket-streaming.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
asyncapi: voiceStream
title: "WebSocket Streaming"
description: "AsyncAPI reference for the real-time voice WebSocket protocol, covering the messages sent in each direction."
---
Loading