{"result":{"depiction_url":null,"edges":{"observes":{"objects":[{"created":"2026-10-06T11:43:52Z","object_id":{"id":2404,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_translate","title":"observe_translate\/2","uri":"https:\/\/zotonic.com\/id\/2404"},"seq":1}],"predicate":{"id":2550,"is_a":["meta","predicate"],"name":"observes","title":{"_type":"trans","tr":{"en":"Observes"}},"uri":"https:\/\/zotonic.com\/id\/observes"}},"refers":{"objects":[{"created":"2026-10-06T11:43:52Z","object_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"seq":1000000}],"predicate":{"id":2409,"is_a":["meta","predicate"],"name":"refers","title":{"_type":"trans","tr":{"en":"Refers"}},"uri":"https:\/\/zotonic.com\/id\/refers"}},"subject":{"objects":[{"created":"2026-10-06T11:43:52Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2561,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_content_editor","title":"Content editor","uri":"https:\/\/zotonic.com\/id\/2561"},"seq":2},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2588,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_localization_and_translation","title":"Localization and translation","uri":"https:\/\/zotonic.com\/id\/2588"},"seq":3},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2592,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_authorization_and_access_control","title":"Authorization and access control","uri":"https:\/\/zotonic.com\/id\/2592"},"seq":4},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2599,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_api_and_integration","title":"API and integration","uri":"https:\/\/zotonic.com\/id\/2599"},"seq":5},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2603,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_configuration","title":"Configuration","uri":"https:\/\/zotonic.com\/id\/2603"},"seq":6},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2635,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_module","title":"Module","uri":"https:\/\/zotonic.com\/id\/2635"},"seq":7},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2668,"is_a":["categorization","keyword","keyword_data_type"],"name":"zotonic_topic_language_code","title":"Language code","uri":"https:\/\/zotonic.com\/id\/2668"},"seq":8},{"created":"2026-10-06T11:43:52Z","object_id":{"id":2669,"is_a":["categorization","keyword","keyword_data_type"],"name":"zotonic_topic_translated_text","title":"Translated text","uri":"https:\/\/zotonic.com\/id\/2669"},"seq":9}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"id":2761,"is_a":["text","documentation","reference","module"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2761"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_external_1_mod_translate_deepl","page_url":{"en":"https:\/\/zotonic.com\/docs\/2761\/mod_translate_deepl","x-default":"https:\/\/zotonic.com\/docs\/2761\/mod_translate_deepl"},"preview_url":null,"resource":{"version":22,"pivot_location_lat":null,"title":"mod_translate_deepl","is_authoritative":true,"body":"<p>Provides automatic text translation through DeepL as a translation service for\nZotonic&#39;s <code>mod_translation<\/code> module.<\/p>\n<h2>Configuration<\/h2>\n<p>Enable <code>mod_translate_deepl<\/code> and set the <code>mod_translate_deepl.api_key<\/code>\nconfiguration value to the site&#39;s DeepL API key. The integration selects the\nfree API endpoint when the key contains <code>:fx<\/code>; otherwise it uses the paid API\nendpoint. No separate endpoint setting is needed.<\/p>\n<p>Grant <code>use.mod_translate_deepl<\/code> to the user groups allowed to request\ntranslations. The observer checks this permission before contacting DeepL.\nTranslation requests send the supplied texts to the external DeepL service\nusing the site&#39;s API key.<\/p>\n<h2>Translation service<\/h2>\n<p>The module handles Zotonic&#39;s <code>translate<\/code> notification and delegates the source\nlanguage, target language, and list of texts to <code>m_translate_deepl:translate\/4<\/code>.\nThis integrates with the translation option in the admin&#39;s add-language dialog.<\/p>\n<p>Texts are sent with HTML tag handling enabled, and text inside <code>code<\/code> elements\nis excluded from translation. Omitting the source language requests automatic\nlanguage detection. Supported language combinations depend on DeepL.<\/p>\n<p>On success the observer returns <code>{ok, TranslatedTexts}<\/code>. If access is denied,\nthe API key is missing, or the request fails, it returns <code>undefined<\/code>, leaving\nthe notification available to other translation providers.<\/p>","slug":"mod_translate_deepl","doc_module_config":[],"is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"2fe61e07ac692f1efe6165ae2767d433f53c6746f0fee0035e3a5499476ec799","doc_module_observers":[{"name":"translate","page_name":"doc_notification_translate"}],"is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"external_module_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"git_url":"https:\/\/github.com\/driebit\/zotonic_mod_translate_deepl","category_id":{"id":320,"is_a":["meta","category"],"name":"module","title":"Modules","uri":"https:\/\/test.zotonic.com\/id\/320"},"doc_source_path":".\/src\/mod_translate_deepl.erl","publication_start":"2026-10-06T11:43:52Z","github_url":"https:\/\/github.com\/driebit\/zotonic_mod_translate_deepl","pivot_location_lng":null,"doc_source_kind":"external","name":"doc_external_1_mod_translate_deepl","is_unfindable":false,"is_published":true,"pivot_geocode":null,"external_module_title":"DeepL","created":"2026-10-06T11:43:52Z","uri":null,"doc_status":"current","is_dependent":false,"is_external_module":true,"publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"56fe0e842fe325b2f19fe4b886ba61ec3abba725","creator_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"modified":"2026-10-06T11:43:53Z","title_slug":"mod_translate_deepl"},"uri":"https:\/\/zotonic.com\/id\/2761","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2761"}},"status":"ok"}