# DeepL
> [!WARNING]
> This package is in active development and considered alpha. APIs and features may change without notice.
[](https://hex.pm/packages/deepl)
[](https://hex.pm/packages/deepl)
The [DeepL API](https://www.deepl.com/docs-api) provides a way for programs to send texts and
documents to DeepL's servers and receive high-quality translations and text improvements. This
enables developers to build a wide range of translation tools using DeepL's leading translation technology.
`deepl` is a **community-maintained** Elixir package for integrating with the DeepL API.
## Requirements
To use `deepl`, your environment must meet these requirements:
- **Erlang**: Version `27.0` or later
- **Elixir**: Version `1.18.0-otp-27` or later
## Installation
To install `deepl`, follow the instructions in the
[Getting Started Guide](https://hexdocs.pm/deepl/getting-started.html).
## Usage
Translate a text:
```elixir
iex> Deepl.Text.translate("Hello World", "ID")
{:ok,
%{
"translations" => [
%{"detected_source_language" => "EN", "text" => "Halo Dunia"}
]
}}
iex> Deepl.Text.translate(["Hello World", "Hello Developer"], "ID")
{:ok,
%{
"translations" => [
%{"detected_source_language" => "EN", "text" => "Halo Dunia"},
%{"detected_source_language" => "EN", "text" => "Halo Pengembang"}
]
}}
iex> Deepl.Text.translate("Hello World", "ID", show_billed_characters: true)
{:ok,
%{
"translations" => [
%{
"billed_characters" => 11,
"detected_source_language" => "EN",
"text" => "Halo Dunia"
}
]
}}
```
## License
This package is licensed under the [MIT License](https://github.com/muzhawir/deepl/blob/main/LICENSE.md).