---
name: deepl-api-documentation
description: "DeepL API Documentation API skill. Use when working with DeepL API Documentation for translate, document, glossary-language-pairs. Covers 39 endpoints."
version: 1.0.0
generator: lapsh
---

# DeepL API Documentation
API version: 3.9.0

## Auth
ApiKey Authorization in header

## Base URL
https://api.deepl.com

## Setup
1. Set your API key in the appropriate header
2. GET /v2/glossary-language-pairs -- list language pairs supported by glossaries
3. POST /v2/translate -- create first translate

## Endpoints
39 endpoints across 10 groups. See references/api-spec.lap for full details.

### Translate
| Method | Path | Description |
|--------|------|-------------|
| POST | /v2/translate | Request Translation |

### Document
| Method | Path | Description |
|--------|------|-------------|
| POST | /v2/document | Upload and Translate a Document |
| POST | /v2/document/{document_id} | Check Document Status |
| POST | /v2/document/{document_id}/result | Download Translated Document |

### Glossary-language-pairs
| Method | Path | Description |
|--------|------|-------------|
| GET | /v2/glossary-language-pairs | List Language Pairs Supported by Glossaries |

### Glossaries
| Method | Path | Description |
|--------|------|-------------|
| POST | /v3/glossaries | Create a Glossary |
| GET | /v3/glossaries | List all Glossaries |
| GET | /v3/glossaries/{glossary_id} | Retrieve Glossary Details |
| PATCH | /v3/glossaries/{glossary_id} | Edit glossary details |
| DELETE | /v3/glossaries/{glossary_id} | Delete a Glossary |
| GET | /v3/glossaries/{glossary_id}/entries | Retrieve Glossary Entries |
| DELETE | /v3/glossaries/{glossary_id}/dictionaries | Deletes the dictionary associated with the given language pair with the given glossary ID. |
| PUT | /v3/glossaries/{glossary_id}/dictionaries | Replaces or creates a dictionary in the glossary with the specified entries. |
| POST | /v2/glossaries | Create a Glossary |
| GET | /v2/glossaries | List all Glossaries |
| GET | /v2/glossaries/{glossary_id} | Retrieve Glossary Details |
| DELETE | /v2/glossaries/{glossary_id} | Delete a Glossary |
| GET | /v2/glossaries/{glossary_id}/entries | Retrieve Glossary Entries |

### Write
| Method | Path | Description |
|--------|------|-------------|
| POST | /v2/write/rephrase | Request text improvement |

### Usage
| Method | Path | Description |
|--------|------|-------------|
| GET | /v2/usage | Check Usage and Limits |

### Languages
| Method | Path | Description |
|--------|------|-------------|
| GET | /v2/languages | Retrieve Supported Languages |

### Admin
| Method | Path | Description |
|--------|------|-------------|
| POST | /v2/admin/developer-keys | Create a developer key as an admin |
| GET | /v2/admin/developer-keys | Get all developer keys as an admin |
| PUT | /v2/admin/developer-keys/deactivate | Deactivate a developer key as an admin |
| PUT | /v2/admin/developer-keys/label | Rename a developer key as an admin |
| PUT | /v2/admin/developer-keys/limits | Set developer key usage limits as an admin |
| GET | /v2/admin/analytics | Get usage statistics as an admin |

### Style_rules
| Method | Path | Description |
|--------|------|-------------|
| GET | /v3/style_rules | Retrieve style rule lists |
| POST | /v3/style_rules | Create a style rule list |
| GET | /v3/style_rules/{style_id} | Retrieve a style rule list |
| PATCH | /v3/style_rules/{style_id} | Update a style rule list |
| DELETE | /v3/style_rules/{style_id} | Delete a style rule list |
| PUT | /v3/style_rules/{style_id}/configured_rules | Update configured rules for a style rule list |
| POST | /v3/style_rules/{style_id}/custom_instructions | Create a custom instruction |
| GET | /v3/style_rules/{style_id}/custom_instructions/{instruction_id} | Retrieve a custom instruction |
| PUT | /v3/style_rules/{style_id}/custom_instructions/{instruction_id} | Update a custom instruction |
| DELETE | /v3/style_rules/{style_id}/custom_instructions/{instruction_id} | Delete a custom instruction |

### Voice
| Method | Path | Description |
|--------|------|-------------|
| POST | /v3/voice/realtime | Get Streaming URL |
| GET | /v3/voice/realtime | Request Reconnection |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a translate?" -> POST /v2/translate
- "Create a document?" -> POST /v2/document
- "Create a result?" -> POST /v2/document/{document_id}/result
- "List all glossary-language-pairs?" -> GET /v2/glossary-language-pairs
- "Create a glossary?" -> POST /v3/glossaries
- "List all glossaries?" -> GET /v3/glossaries
- "Get glossary details?" -> GET /v3/glossaries/{glossary_id}
- "Partially update a glossary?" -> PATCH /v3/glossaries/{glossary_id}
- "Delete a glossary?" -> DELETE /v3/glossaries/{glossary_id}
- "List all entries?" -> GET /v3/glossaries/{glossary_id}/entries
- "Create a rephrase?" -> POST /v2/write/rephrase
- "List all usage?" -> GET /v2/usage
- "List all languages?" -> GET /v2/languages
- "Create a developer-key?" -> POST /v2/admin/developer-keys
- "List all developer-keys?" -> GET /v2/admin/developer-keys
- "List all analytics?" -> GET /v2/admin/analytics
- "List all style_rules?" -> GET /v3/style_rules
- "Create a style_rule?" -> POST /v3/style_rules
- "Get style_rule details?" -> GET /v3/style_rules/{style_id}
- "Partially update a style_rule?" -> PATCH /v3/style_rules/{style_id}
- "Delete a style_rule?" -> DELETE /v3/style_rules/{style_id}
- "Create a custom_instruction?" -> POST /v3/style_rules/{style_id}/custom_instructions
- "Get custom_instruction details?" -> GET /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
- "Update a custom_instruction?" -> PUT /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
- "Delete a custom_instruction?" -> DELETE /v3/style_rules/{style_id}/custom_instructions/{instruction_id}
- "Create a realtime?" -> POST /v3/voice/realtime
- "List all realtime?" -> GET /v3/voice/realtime
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success
- Error responses include status codes and descriptions in the spec

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)