This repo is home to the DeepL Developer Docs and the authoritative OpenAPI specification of the DeepL API.
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mint
Run the following command at the root of your documentation (where docs.json is)
mint dev
If you have the deprecated mintlify package installed, replace it with mint:
npm uninstall -g mintlify
npm cache clean --force
npm i -g mint
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
- Mint dev isn't running - Run
mint installto re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json
Agents in .claude/agents/ are automatically available to anyone who clones this repo:
| Agent | Purpose | When to use |
|---|---|---|
diataxis |
Full Diataxis framework expert for both writing and reviewing | Writing new content or checking type adherence |
docs-review |
Orchestrator that runs editorial + Diataxis reviews in parallel and writes a single report | Before opening a PR, or reviewing someone else's PR |
editorial-reviewer |
Checks style, structure, code examples against CLAUDE.md | Called by docs-review (you don't need to invoke directly) |
Writing new content:
Use the diataxis agent to help me write a how-to guide for [topic]
Before opening a PR:
Use the docs-review agent on [filename]
Check for broken links:
mint broken-links
mint broken-links --check-anchors
This project contains an OpenAPI specification of the DeepL API, in YAML and JSON formats.
| File | Purpose |
|---|---|
api-reference/openapi.yaml |
Main REST API spec (source of truth) |
api-reference/openapi.json |
Same content, JSON format (auto-generated) |
api-reference/voice/voice.asyncapi.yaml |
AsyncAPI spec for the streaming voice API (source of truth) |
api-reference/voice/voice.asyncapi.json |
Same content, JSON format (auto-generated) |
You can use this specification to explore the API in tools like Postman, or to auto-generate documentation, SDKs, and code libraries using tools such as Swagger Editor or OpenAPI Generator.
Note that Swagger's "Try it out" in-browser simulator creates valid Curl requests, the requests will fail due to CORS restrictions.
For release notes and the latest API changes, see Roadmap and release notes.
If you encounter issues while using this OpenAPI specification or have feature requests, please create an issue.
The JSON files are auto-generated from the YAML sources. Don't edit them by hand.
A GitHub Actions workflow regenerates them on any PR that touches the YAML sources and commits the result back to the PR branch. To preview locally:
yq -o=json '.' api-reference/openapi.yaml > api-reference/openapi.json yq -o=json '.' api-reference/voice/voice.asyncapi.yaml > api-reference/voice/voice.asyncapi.json