Before You Start
Access to Knak Admin settings
A translation tool that supports API workflows
Basic knowledge of API authentication
Set Up API Access
Create an API Role
Open Knak Builder
Click Admin (top left)
Click Company > Roles > + Create Role
Add Role Name: API User
Add Role Description (optional)
Add permissions:
Request Translations
Can Manage API Tokens
(Optional) Request Translations for Unapproved Email
Click Create
Create an API User
Click Company > Users > Invite User
Enter user details:
Email
First name
Last name
Select the API role you created
Click Save User and Send Invite
💡 Tip: Use email alias format (example: youremail+api@domain.com)
Set Up Authentication
Use OAuth2 (Open Authorization 2.0) for secure API access.
Sign in using your API user
Create an OAuth application
Grant required permissions
OAuth setup:
API authentication docs: https://enterprise.knak.io/docs/api#section/Overview/Authentication
Configure the Integration
Create a Webhook
Go to Admin > Integrations > Webhooks
Click Create Webhook
Enter:
Webhook Name
Payload URL
Under Subscribed Events, select:
asset.translation_requested
Create a Custom Translation Integration
Go to Admin > Integrations > Platforms
Scroll to Translations
Click Connect on the Custom Translations Integration Tile
After setup, the webhook appears on the integration tile.
Optional Settings:
Hide Due Date
Hide the due date field
Simplify the submission flow
Restrict by Brand
Select Brand Restricted
Choose allowed brands
Only selected brands can use the integration.
Create Translation Requests
Open an asset
Click Translate tab
Click Translate Now
Select your custom integration
Select Primary Language of your base asset
Choose target languages
Click Submit Request
Process Translations via API
Follow this workflow:
Create translation requests in Knak using the custom translation integration
Query for translation requests via the API
Or wait for webhook event to notify of new translation requests
Fetch metadata for new translation requests via the API
Fetch the translation source file for translation requests via the API
Process the translation source file in your custom translation tool
Upload the translated file to a translation request via the API
View the translated variant of the completed translation request in the Knak editor
Managing Your Integration
Go to My Platform Connection to view, edit, or delete the integration.
To add another connection, scroll through the Platforms page to get to the Translations section and click Add Another Connection.
FAQs
What is the language code format for translation requests?
By default, the format for language codes is a 2-character code that indicates the language. Below is a list of the default languages.
Language Code | Language Name |
zh | Chinese |
es | Spanish |
en | English |
hi | Hindi |
ar | Arabic |
pt | Portuguese |
ru | Russian |
ja | Japanese |
de | German |
ms | Malay |
id | Indonesian |
vi | Vietnamese |
ko | Korean |
fr | French |
it | Italian |
th | Thai |
Need more help? Contact support via live chat using the chat bubble in the bottom right corner or email support@knak.com.