Permission Scopes - DeepL Documentation

Translate text (translate:text)

Method	Endpoint
`POST`	`/v2/translate`

Translate document (translate:document)

Method	Endpoint
`POST`	`/v2/document`
`GET`	`/v2/document/{document_id}`
`GET`	`/v2/document/{document_id}/result`

Translate real-time speech (voice:realtime)

Method	Endpoint
`POST`	`/v3/voice/realtime`
`GET`	`/v3/voice/realtime`

This scope also covers the WebSocket stream. You open the stream with the streaming URL and token from one of the endpoints above, so a scoped key needs voice:realtime to use any part of a real-time session.

Rephrase or correct text (write:improve)

Method	Endpoint
`POST`	`/v2/write/rephrase`
`POST`	`/v2/write/correct`

View glossaries and their entries (glossaries:read)

Method	Endpoint
`GET`	`/v3/glossaries`
`GET`	`/v3/glossaries/{glossary_id}`
`GET`	`/v3/glossaries/{glossary_id}/entries`
`GET`	`/v2/glossaries`
`GET`	`/v2/glossaries/{glossary_id}`
`GET`	`/v2/glossaries/{glossary_id}/entries`
`GET`	`/v2/glossary-language-pairs`

Create, modify, and delete glossaries (glossaries:write)

Method	Endpoint
`POST`	`/v3/glossaries`
`PATCH`	`/v3/glossaries/{glossary_id}`
`PUT`	`/v3/glossaries/{glossary_id}/dictionaries`
`DELETE`	`/v3/glossaries/{glossary_id}`
`DELETE`	`/v3/glossaries/{glossary_id}/dictionaries`
`POST`	`/v2/glossaries`
`DELETE`	`/v2/glossaries/{glossary_id}`

View style rules and custom instructions (style_rules:read)

Method	Endpoint
`GET`	`/v3/style_rules`
`GET`	`/v3/style_rules/{style_id}`
`GET`	`/v3/style_rules/{style_id}/custom_instructions/{instruction_id}`

Create, modify, and delete style rules and custom instructions (style_rules:write)

Method	Endpoint
`POST`	`/v3/style_rules`
`PATCH`	`/v3/style_rules/{style_id}`
`PUT`	`/v3/style_rules/{style_id}/configured_rules`
`DELETE`	`/v3/style_rules/{style_id}`
`POST`	`/v3/style_rules/{style_id}/custom_instructions`
`PUT`	`/v3/style_rules/{style_id}/custom_instructions/{instruction_id}`
`DELETE`	`/v3/style_rules/{style_id}/custom_instructions/{instruction_id}`

Retrieve and export translation memories (translation_memories:read)

Method	Endpoint
`GET`	`/v3/translation_memories`
`GET`	`/v3/translation_memories/{translation_memory_id}`
`GET`	`/v3/translation_memories/{translation_memory_id}/segments`
`POST`	`/v3/translation_memories/{translation_memory_id}/export`
`GET`	`/v3/translation_memories/jobs/{job_id}`

Exporting is a read operation, so it needs translation_memories:read rather than translation_memories:write, even though it uses POST.

Import and delete translation memories (translation_memories:write)

Method	Endpoint
`POST`	`/v3/translation_memories/import`
`DELETE`	`/v3/translation_memories/{translation_memory_id}`

Retrieve languages and resources (languages:read)

Method	Endpoint
`GET`	`/v3/languages`
`GET`	`/v3/languages/resources`
`GET`	`/v2/languages`

View subscription usage and limits (usage:read)

Method	Endpoint
`GET`	`/v2/usage`