Skip to main content
DeepL
Previewv0.1.0
57 actions · 1 auth method
Translation

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Works with both DeepL API Free and DeepL API Pro keys. Translation memories, style rules, spoken terms and voice need a…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

57 actions
Action
Description
Get Admin Usage Analytics
Retrieve usage statistics for the organization within a specified date range.
Get Admin Custom Tag Analytics
Retrieve usage statistics broken down by custom tags within a specified date range.
Create Developer Key
Create a developer key in your organization with the given label and return its metadata, including the key_id.
List Developer Keys
List every developer key in your organization, including labels, creation and deactivation timestamps, and any configure…
Deactivate Developer Key
Deactivate a developer key so it can no longer authenticate API requests.
Rename Developer Key
Change the label of a developer key.
Set Developer Key Usage Limits
Set per-key usage limits for characters, speech-to-text milliseconds, and speech-to-speech milliseconds.
Upload Document For Translation
Upload a document for translation and receive a document_id and document_key.
Get Document Translation Status
Retrieve the translation status of an uploaded document.
Download Translated Document
Download a translated document.
Create Glossary
Create a glossary containing one or more dictionaries, each holding entries for a single source and target language pair…
List Glossaries
List all glossaries and their meta-information, but not the glossary entries.
Get Glossary
Retrieve meta information for a single glossary, omitting the glossary entries.
Update Glossary
Edit glossary details, such as name or a dictionary for a source and target language.
Delete Glossary
Deletes the specified glossary.
Get Glossary Entries
List the entries of a single glossary in tsv format.
Delete Glossary Dictionary
Delete the dictionary for a single source and target language pair from a glossary, leaving the glossary and its other d…
Replace Glossary Dictionary
Replace all entries in the dictionary for a source and target language pair, or create the dictionary if it does not exi…
List Language Resources
Returns all DeepL API resources and the features they support.
List Languages
Returns languages supported by the specified DeepL API resource.
Get Quality Evaluation
Returns the current state of a quality evaluation; poll until the evaluation completes to get the full report.
Create Spoken Terms
Create a new Spoken Terms collection with one or more term lists.
List Spoken Terms
List all Spoken Terms collections and their metadata, but not the actual terms.
Get Spoken Terms
Retrieve metadata for a Spoken Terms collection, including term list information but not the actual terms.
Update Spoken Terms
Update the name of a Spoken Terms collection or merge new entries into an existing term list.
Delete Spoken Terms
Delete the entire Spoken Terms collection.
Get Spoken Terms Entries
Retrieve the actual terms for a specific language from a Spoken Terms collection.
Replace Spoken Terms List
Replace an existing term list for a language, or create a new one if it doesn’t exist.
Delete Spoken Terms List
Delete a term list for a specific language from the Spoken Terms collection.
List Style Profiles
Retrieve a list of style profiles available to the authenticated account, newest first.
Create Style Profile
Create a style profile.
Get Style Profile
Retrieve a single style profile by its ID, including the components it links and its timestamps.
Update Style Profile
Update a style profile you own or that was shared with you for editing.
Delete Style Profile
Delete a style profile.
List Style Rule Lists
List the style rule lists in your account.
Create Style Rule List
Create a style rule list for a single language, optionally with its configured rules and custom instructions.
Get Style Rule List
Retrieve a single style rule list, including its configured rules and custom instructions.
Update Style Rule List
Rename a style rule list.
Delete Style Rule List
Delete a style rule list and its custom instructions.
Update Style Rule Configured Rules
Replace the full set of configured rules on a style rule list.
Create Custom Instruction
Add a custom instruction to a style rule list to express a style preference that the predefined rules do not cover.
Get Custom Instruction
Retrieve a single custom instruction from a style rule list.
Update Custom Instruction
Replace a custom instruction.
Delete Custom Instruction
Delete a custom instruction from a style rule list.
List Translation Memories
Retrieve a list of translation memories associated with the authenticated account.
Import Translation Memory
Create a translation memory by importing a TMX file.
Get Translation Memory Job
Retrieve the status of a translation memory import or export job.
Get Translation Memory
Retrieve a single translation memory by its ID, including its languages and segment count.
Delete Translation Memory
Delete a translation memory and all of its segments.
List Translation Memory Segments
List the segments stored in a translation memory, one page at a time.
Export Translation Memory
Export a translation memory as a TMX file.
Translate Text
Translate one or more text strings into a target language.
Get Usage
Retrieve character and minute usage for the current billing period together with the corresponding account limits.
Create Voice Translation Job
Creates an async voice translation job.
Get Voice Translation Job
Returns the current status of a voice translation job, including per-target result statuses.
Rephrase Text
Rewrite one or more texts to improve fluency and readability, optionally targeting a specific writing style or tone.
Correct Text
Fix spelling and grammar errors in one or more texts.