WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Add image file formats to docs #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lilkraftwerk wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add image file formats to docs #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion api-reference/document.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The document translation API allows you to translate whole documents and support
* `txt` - Plain Text Document
* `xlf / xliff` - XLIFF Document, version 2.1
* `srt` - SRT (SubRip Subtitle) Document
* `jpeg` / `jpg` / `png` - Image

Please note that with every submitted document of type .pptx, .docx, .doc, .xlsx, or .pdf, you are billed a minimum of 50,000 characters with the DeepL API plan, no matter how many characters are included in the document.

Expand Down Expand Up @@ -136,7 +137,9 @@ These examples are for demonstration purposes only. In production code, the auth
<li>`pdf`: Portable Document Format</li>
<li>`htm / .html`: HTML Document</li>
<li>`txt`: Plain Text Document</li>
<li>`xlf / .xliff`: XLIFF Document, version 2.1</li>
<li>`xlf / xliff`: XLIFF Document, version 2.1</li>
<li>`srt` - SRT (SubRip Subtitle) Document</li>
<li>`jpeg` / `jpg` / `png` - Image</li>
</ul>
</ParamField>
<ParamField body="filename" type="string">
Expand Down
2 changes: 2 additions & 0 deletions api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ tags:
* `txt` - Plain Text Document
* `xlf / xliff` - XLIFF Document, version 2.1
* `srt` - SRT Document
* `jpeg` / `jpg` / `png` - Image
- name: RephraseText
description: |-
The `rephrase` endpoint is used to make corrections and adjustments to texts based on style or tone.
Expand Down Expand Up @@ -622,6 +623,7 @@ paths:
* `txt` - Plain Text Document
* `xlf / xliff` - XLIFF Document, version 2.1
* `srt` - SRT Document
* `jpeg` / `jpg` / `png` - Image
filename:
type: string
description: The name of the uploaded file. Can be used as an alternative
Expand Down
1 change: 1 addition & 0 deletions docs/resources/roadmap-and-release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ rss: true
- Added HE, TH and VI to the languages endpoint, since they are now also available in document translation
- Added 6 additional beta languages, for text and document translation. See the previous note about 75 new languages.
- Added a new parameter to the text translation API to allow custom instructions, making it possible to customize the translation behavior (e.g. ["Use a friendly, diplomatic tone"])
- Added support for JPEG and PNG images in [document translation](/api-reference/document), currently in Beta.
</Update>

<Update label="Q3 2025">
Expand Down
26 changes: 14 additions & 12 deletions docs/resources/usage-limits.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,20 @@ title: "Usage and limits"

### Maximum Upload Limits Per Document Format

| File Format | DeepL API Free | DeepL API Pro |
| --------------------- | ------------------------------ | -------------------------------- |
| Word (.docx / .doc) | 10 MB<br />500,000 characters | 30 MB<br />1 million characters |
| PowerPoint (.pptx) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| Excel (.xlsx) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| PDF (.pdf) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| Text (.txt) | 1 MB<br />500,000 characters | 1 MB <br />1 million characters |
| HTML (.html) | 5 MB<br />500,000 characters | 5 MB<br />1 million characters |
| XLIFF (.xlf/.xliff)\* | 10 MB<br />500,000 characters | 10 MB<br />1 million characters |
| SRT (.srt) | 150 KB<br />500,000 characters | 150 KB<br />1 million characters |

*Please note that DeepL only supports .xliff files with the version 2.1.
| File Format | DeepL API Free | DeepL API Pro |
| ----------------------- | ------------------------------ | -------------------------------- |
| Word (.docx / .doc) | 10 MB<br />500,000 characters | 30 MB<br />1 million characters |
| PowerPoint (.pptx) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| Excel (.xlsx) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| PDF (.pdf) | 10 MB <br />500,000 characters | 30 MB<br />1 million characters |
| Text (.txt) | 1 MB<br />500,000 characters | 1 MB <br />1 million characters |
| HTML (.html) | 5 MB<br />500,000 characters | 5 MB<br />1 million characters |
| XLIFF (.xlf/.xliff)\* | 10 MB<br />500,000 characters | 10 MB<br />1 million characters |
| SRT (.srt) | 150 KB<br />500,000 characters | 150 KB<br />1 million characters |
| Images (.jpeg/.png)\*\* | 3 MB<br />500,000 characters | 3 MB<br />1 million characters |

*Please note that DeepL only supports .xliff files with the version 2.1.<br />
**Image translation is currently in Beta. During the Beta phase, characters translated in image file formats are not billed and not counted against your character threshold.

### Your Usage

Expand Down