Connectors Reference
You can now professionally translate your documents or any other kind of content with MotaWord connector. We support many content/file types into 95+ languages with 18000+ professional translators. We are everywhere you are! Check our website and mobile apps to track your translatiosn in real-time.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
InitializeTranslationProject (InitializeTranslationProjectParameterBody body) |
Initialize Translation Project |
|
Get project details |
|
|
DownloadTranslations (integer projectId, [Optional]integer async) |
Download Translations |
|
Delete project webhook |
|
|
Launch Translation Project |
|
|
Add Document(s) For Translation |
|
Name |
Summary |
|
When Translation Project Completed |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Initialize Translation Project
Description: Initialize a new translation project at MotaWord. You can later add document(s) to it, and then launch it.
Syntax:
MotaWordTranslations.InitializeTranslationProject (InitializeTranslationProjectParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
InitializeTranslationProjectParameterBody
|
|
True |
Returns:
Type:InitializeTranslationProjectResponse
Summary: Get project details
Description: Get your project details, including quote price and word count. You can also use this endpoint to get your latest price and word count after uploading new source documents or changing language pairs.
Syntax:
MotaWordTranslations.GetProjectDetails (integer projectId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
integer (Project ID) |
Project ID for. |
True |
Returns:
Type:GetProjectDetailsResponse
Summary: Download Translations
Description: Download translated documents as a ZIP archive from your MotaWord project
Syntax:
MotaWordTranslations.DownloadTranslations (integer projectId, [Optional]integer async)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
integer(int64) (Project ID that you want to download translations of.) |
Project ID that you want to download translations of. |
True |
|
|
async |
integer (For the most fresh package, choose 0/false/no.)Values: [, ] |
When you download your translations, we recompile them and give you a fresh package. We can do this in the background or foreground. In most cases of integration as a connector, this should be async = 0. |
False |
Returns:
Type:string(binary)
Summary: Delete project webhook
Description: Delete project webhook
Syntax:
MotaWordTranslations.DeleteProjectWebhooks (string projectId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project ID that you want to delete webhooks of.) |
Project ID that you want to delete webhooks of. |
True |
Returns:
Type:DeleteProjectWebhooksResponse
Summary: Launch Translation Project
Description: Launch your existing project (quote) for translation, we'll get to it right away. Remember to add your documents to a project before you launch it. Once launched, you can also track your translation progress in real-time on our web and mobile platforms.
Syntax:
MotaWordTranslations.LaunchTranslationProject (string projectID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectID |
string (Project ID that you want to launch.) |
Project ID that you want to launch. |
True |
Returns:
Type:LaunchTranslationProjectResponse
Summary: Add Document(s) For Translation
Description: Add document(s) to your translation project. You can only add a new document to a project that you haven't yet launched.
Syntax:
MotaWordTranslations.AddDocumentsForTranslation (string projectID, [Optional]AddDocumentsForTranslationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectID |
string (Project ID that you want to add documents to.) |
Project ID that you want to add documents to. This project is typically initialized via InitializeTranslationProject action earlier in the workflow. |
True |
|
|
body |
AddDocumentsForTranslationParameterBody
|
|
False |
Returns:
Type:AddDocumentsForTranslationResponse
Summary: When Translation Project Completed
Description: Triggered when your translation project is completed. Register project status webhook here.
Syntax:
MotaWordTranslations.WhenTranslationProjectCompleted (integer projectId, WhenTranslationProjectCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
integer (Project ID that you want to register webhooks for.) |
Project ID that you want to register webhooks for. |
True |
|
|
body |
WhenTranslationProjectCompletedParameterBody
|
|
True |
Returns:
Type:WhenTranslationProjectCompletedResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (DocumentsItem)
|
List of document objects to be uploaded. Documents are list of objects containing file name and base64 encoded content. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string What do you want to name this file on MotaWord side? |
This is the name of the file that you want translated. MotaWord platform will only know your file by this name. |
|
data |
string(byte) Base64 encoded content of the file you want translated. |
Base64 encoded content of the file you want translated. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (DocumentsItem)
|
List of documents that you have just uploaded. Only returns newly uploaded files, not all of the files in your project. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
MotaWord ID for the document you just uploaded. |
|
name |
string
|
Document name |
|
uploaded_at |
integer(int32)
|
Unix timestamp for when this document was uploaded. |
|
word_count |
integer(int32)
|
Number of words in the document to be translated. This is the amount we charge you for. |
|
scheme |
|
Mixed file scheme object. For more information in configuring your source files, refer to our Developer Portal: https://www.motaword.com/developer |
Summary:
Description: Mixed file scheme object. For more information in configuring your source files, refer to our Developer Portal: https://www.motaword.com/developer
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project ID. This is the ID that other actions usually make use of, such as downloading translations from a MotaWord project. |
|
source_language |
string
|
Source language code of your project. Language codes are available here: http://api.motaword.com/languages |
|
target_languages |
array of (string)
|
Target language codes of your project. Language codes are available here: http://api.motaword.com/languages |
|
word_count |
integer(int32)
|
Total word count of your files in this project. We base our quotes on the number of words you are ordering for translation. |
|
price |
|
Price and currency information of your project. |
|
price_without_discount |
|
MotaWord works hard to give you discounts over Translation Memory, content exclusion and such. This is the project price without any of our discounts. This is only for information purposes. |
|
status |
string
|
Project status. Values: [pending, started, translated, completed] |
|
delivery_at |
integer(int32)
|
Unix timestamp for project deadline we provide to you. |
|
completed_on |
string
|
If the project has been completed, this will tell you when it was completed. Unix timestamp. |
|
valid_until |
integer(int32)
|
Your projects are available for 30 days before you launch them. Once your quote expires after 30 days, you will need to get a new quote. |
|
custom |
string
|
You can put any custom key-value pair here and we will always accompany project entities with this custom metadata. This is a useful field to improve your workflows with custom data/tracking exchange with MotaWord. |
|
callback_url |
string
|
Callback URL is used to update your flows with MotaWord project status changes. This URL is typically generated from a 'HTTP Request Trigger' connector. You can also use our native Trigger for webhook and status change tracking purposes. |
|
created_at |
integer(int32)
|
Unix timestamp for when this project was first submitted. |
Summary:
Description: Price and currency information of your project.
Properties:
|
Name |
Type |
Summary |
|
amount |
number(float)
|
Monetary quote amount. Make sure to use `currency` field as well. |
|
currency |
string
|
Currency of your translation quote. |
|
usd_amount |
number(float)
|
If the currency is different than USD, then this field can tell you its USD equivelant. |
Summary:
Description: MotaWord works hard to give you discounts over Translation Memory, content exclusion and such. This is the project price without any of our discounts. This is only for information purposes.
Properties:
|
Name |
Type |
Summary |
|
amount |
number(float)
|
Monetary quote amount. Make sure to use `currency` field as well. |
|
currency |
string
|
Currency of your translation quote. |
|
usd_amount |
number(float)
|
If the currency is different than USD, then this field can tell you its USD equivelant. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documents |
array of (DocumentsItem)
|
|
|
callback_url |
string
|
Callback URL is used to update your flows with MotaWord project status changes. |
|
source_language |
string
|
Source language code of the file(s) that you are sending for translation. Language codes are available here: http://api.motaword.com/languages |
|
target_languages |
array of (string)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
This is the name of the file that you want translated. MotaWord platform will only know your file by this name. |
|
data |
string(byte)
|
Base64 encoded content of the file you want translated. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Project ID. This is the ID that other actions usually make use of, such as downloading translations from a MotaWord project. |
|
source_language |
string
|
Source language code of your project. Language codes are available here: http://api.motaword.com/languages |
|
target_languages |
array of (string)
|
Target language codes of your project. Language codes are available here: http://api.motaword.com/languages |
|
word_count |
integer(int32)
|
Total word count of your files in this project. We base our quotes on the number of words you are ordering for translation. |
|
price |
|
Price and currency information of your project. |
|
price_without_discount |
|
MotaWord works hard to give you discounts over Translation Memory, content exclusion and such. This is the project price without any of our discounts. This is only for information purposes. |
|
status |
string
|
Project status. Values: [pending, started, translated, completed] |
|
delivery_at |
integer(int32)
|
Unix timestamp for project deadline we provide to you. |
|
completed_on |
string
|
If the project has been completed, this will tell you when it was completed. Unix timestamp. |
|
valid_until |
integer(int32)
|
Your projects are available for 30 days before you launch them. Once your quote expires after 30 days, you will need to get a new quote. |
|
custom |
string
|
You can put any custom key-value pair here and we will always accompany project entities with this custom metadata. This is a useful field to improve your workflows with custom data/tracking exchange with MotaWord. |
|
callback_url |
string
|
Callback URL is used to update your flows with MotaWord project status changes. This URL is typically generated from a 'HTTP Request Trigger' connector. You can also use our native Trigger for webhook and status change tracking purposes. |
|
created_at |
integer(int32)
|
Unix timestamp for when this project was first submitted. |
Summary:
Description: Price and currency information of your project.
Properties:
|
Name |
Type |
Summary |
|
amount |
number(float)
|
Monetary quote amount. Make sure to use `currency` field as well. |
|
currency |
string
|
Currency of your translation quote. |
|
usd_amount |
number(float)
|
If the currency is different than USD, then this field can tell you its USD equivelant. |
Summary:
Description: MotaWord works hard to give you discounts over Translation Memory, content exclusion and such. This is the project price without any of our discounts. This is only for information purposes.
Properties:
|
Name |
Type |
Summary |
|
amount |
number(float)
|
Monetary quote amount. Make sure to use `currency` field as well. |
|
currency |
string
|
Currency of your translation quote. |
|
usd_amount |
number(float)
|
If the currency is different than USD, then this field can tell you its USD equivelant. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Launch operation status. Values: [started, failed] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callback_url |
string Webhook URL is used to update your flows with MotaWord project status changes. |
Webhook URL is used to update your flows with MotaWord project status changes. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |