Overview

The Redokun API connects your own tools to Redokun. Your CMS, your PIM or an internal script can send documents to Redokun for translation, check how each translation is going and get the translated files back, without anyone uploading or downloading files by hand.

This page is for everyone on the team. The first part explains what the API can do for content and marketing teams. The last part points developers to where they start.

What is an APICopy Anchor Link

An API (application programming interface) lets one program talk to another. Instead of a person working in the Redokun web app, a program sends a request to Redokun and gets an answer back. Using the API means writing code, so a developer usually sets up the integration once, and the team then benefits from it every day.

What you can do todayCopy Anchor Link

With the API, your tools can:

• Send documents for translation. Upload a file, choose its source language and the languages to translate it into. Redokun accepts the same formats as the web app: InDesign (.idml), Word, PowerPoint, Excel, PDF, HTML, XML, JSON, XLIFF, subtitles (.srt) and plain text, up to 100 MB per file.
• Assign translators. For each language, list the email addresses of its translators. Members of your team are assigned at once. Anyone else is invited to your team as a translator and gets an invitation email.
• Pre-translate. Fill each language with matches from your team's translation memory, then with machine translation, so translators start from a first draft instead of a blank page.
• Track progress for each language. See whether a translation is being pre-translated, how many segments are translated and confirmed, and who is working on it.
• Get the translated files. When a language is ready, generate its translated file and download it. The same call can confirm the translation first.
• List your documents. Get every document of your team, newest first, with its status and word count.
• Check the languages you can use. Get the list of languages your account can translate from and into.

Ideas for your teamCopy Anchor Link

These ideas come from what our customers told us they want to automate.

• Upload a whole folder, not one file at a time. Your team saves the finished InDesign, Word or Excel files to a set folder in SharePoint, Microsoft Teams or Google Drive. The integration uploads each file to Redokun with its languages and translators, so nobody has to upload and assign each one by hand.
• Start a translation from a request form. A regional team asks for a translation through a form, such as Microsoft Forms. The integration uploads the file with the languages they asked for and invites the matching translators.
• Send new content from your CMS. When a page or a course is ready in Contentful, Storyblok or WordPress, the integration exports it as HTML, JSON or XML and sends it to Redokun. When the translation is ready, it brings the translated version back to the CMS for approval.
• Save translated files back where they came from. When each language is confirmed, the integration downloads the translated file to the same SharePoint or Google Drive folder and lets the designer know it is there.
• Create subtitle drafts. Upload a subtitle file (.srt), pre-translate it from your translation memory and machine translation, and download the translated subtitles for your video tool.
• Get every language started at once. One upload creates a translation for each target language, up to 50 languages, and assigns its translators.
• Keep your project tool up to date. When a translation task is created in Asana or Jira, the integration uploads the file and assigns the translators, then updates the task with the progress of each language and marks it when every language is confirmed.
• See which languages are ready. Show the completion of each language in a dashboard, a weekly report or a Microsoft Teams channel, so you know which markets are ready without opening each document.

What is not in the API yetCopy Anchor Link

Customers have also asked for these, and the API cannot do them yet:

• Add languages to a document already in Redokun. Choose all the target languages when you upload the file.
• Use your translation memory or glossary from other tools, such as an AI assistant.
• Notify your tools when a translation changes. The integration checks the progress at regular intervals instead.

Translators still review and edit their translations in the Redokun web app, as usual.

Tell us what you want to automateCopy Anchor Link

The API is in beta, and what customers tell us shapes what we build next. Send us feedback any time with the feedback form, as often as you like.

If you are stuck or something does not work, write to support@redokun.com and we will help you.

What you needCopy Anchor Link

1. A plan that includes the API. The API is included in the Premium plan at no additional cost. On the Basic plan, it is available as an add-on: to get it, write to support@redokun.com. The API is not available during the free trial or with a Project Pass. When your plan includes it, the team leader sees Public API in the Redokun settings.
2. The team leader, to create the API key. Only the team leader can create it. See Get an API key.
3. A developer, to build the integration. The API runs from a server, not from a browser, so the developer sets it up in your systems.

For developersCopy Anchor Link

Start with the Introduction for the base URL and your first call, then read Authentication. The endpoints are listed under Endpoints in the sidebar.