MotaWord API

Tools (224)

Extracted live via the executor SDK.

• activity.getActivities

  Get a list of real-time activities in the project, such as translation suggestion and translation approval.

• activity.getActivity

  View the details of an activity in the project.

• activity.getActivityComments

  View a list of comments added to this activity.

• activity.getComments

  View a list of activity comments in the project.

• activity.getSalesActivities

  Get sales activities for a project

• activity.insertSalesActivity

  Insert sales activity for a project

• activity.submitComment

  Submit a comment to an activity in the project, such as translation or editing.

• async.downloadAsync

  Download the result of an async operation that you have requested in other endpoints.

• auth.getAccessToken

  MotaWord API is using OAuth2 procedures when authenticating or authorizing your API call.

• blog.getBlogPosts

  Get blog posts - ordered by created desc by default

• cache.deleteCache

  Clear cache by key

• commission.getCommissions

  Returns a commission list of current client.

• commission.getCommissionsByFilter

  Returns a commission list of current client.

• continuousProject.addDocument

  Add a new document to your continuous project. If the name already exists, it will update the existing document. In most scenarios, this operation will also trigger auto-translation of your document, via MT and/or TM.

• continuousProject.collectAnalytics

  Save/collect analytics data from Active widget

• continuousProject.complete

  Complete continuous project

• continuousProject.completeContinuousDocument

  Complete a continuous project document. Per your project settings, a continuous project document can be target language-specific or project-wide for all target languages of the project.

• continuousProject.completeLanguage

  Complete continuous project language

• continuousProject.createActiveWidget

  Create a new widget for your Active project to be used in your website. Most website-specific configuration is provided via widgets. This does not create a new Active project, just a separate widget.

• continuousProject.createContinuousProject

  Create a new continuous project for your software, website, CI/CD translation needs.

• continuousProject.createSubscription

  Create subscription for continuous project

• continuousProject.deleteActiveWidget

  Delete a single widget for this Active project

• continuousProject.deleteContinuousProject

  Delete an existing continuous project. Your project will be cancelled, and you will still be charged for the amount of translations we have done for you so far.

• continuousProject.deleteSubscription

  Delete subscription for continuous project

• continuousProject.getActiveWidget

  View the details of an Active widget to be used in your website. Most website-specific configuration is provided via widgets.

• continuousProject.getActiveWidgets

  View a list of widgets in your Active project to be used in your website. Most website-specific configuration is provided via widgets.

• continuousProject.getAnalyticsToken

  Get JWT token to be used in analytics dashboards

• continuousProject.getContinuousProject

  View the details of a continuous project.

• continuousProject.getContinuousProjectDocument

  View the details of a source document in continuous translation project.

• continuousProject.getContinuousProjectDocumentProgress

  Monitor the translation progress of a document in a continuous project in real-time.

• continuousProject.getContinuousProjectDocuments

  View the documents under this continuous project

• continuousProject.getContinuousProjectInvoices

  Get real-time access to a continuous project's invoices.

• continuousProject.getContinuousProjectProgress

  Monitor the translation progress of an ongoing continuous project in real-time.

• continuousProject.getContinuousProjects

  View a list of continuous projects under your account. Continuous projects are those that are constantly updated, such as a CI/CD project, software project, website translation and such.

• continuousProject.getQuoteForDocument

  Get a new quote for provided document in continuous project. Per your project settings, a continuous project document can be target language-specific or project-wide for all target languages of the project.

• continuousProject.getQuoteForDocuments

  Get a new quote for provided documents in continuous project

• continuousProject.getQuoteForLanguage

  Get a new quote for provided target language in continuous project

• continuousProject.getQuoteForLanguages

  Get a new quote for provided target languages in continuous project

• continuousProject.getSubscription

  Get subscription for continuous project

• continuousProject.postContinuousProjectDocumentProgress

  Get continuous project document progress for multiple IDs

• continuousProject.resetActiveWidgetToken

  Reset the public token used with your Active widget. This token is used when communicating from your environment to MotaWord systems for translation, analytics and meta.

• continuousProject.translate

  Instantly translate your content with your existing TM and MT resources. This is the primary endpoint to translate your files and content on the fly, especially in CI/CD environments. This is a complex endpoint that is configured in your Active or Continuous Project dashboards. For instance, you can configure whether to use your TM, or translate missing strings via MT and then post-edit those new translations. There are various scenarios you can establish via a set of configurations.

• continuousProject.updateActiveWidget

  Update Active widget settings.

• continuousProject.updateContinuousProject

  Update the details and settings of continuous project.

• continuousProject.updateDocument

  Update source document in your continuous project. In most scenarios, this operation will also trigger auto-translation of your document, via MT and/or TM.

• continuousProject.updateSubscription

  Update subscription for continuous project

• continuousProject.updateSubscriptionPaymentMethod

  Update subscription payment method for continuous project

• corporate.getAvailableCorporatePermissions

  View a list of available permissions for your corporate account. They are used when assigning permissions to your corporate users.

• corporate.getAvailableCorporatePermissionsById

  Get a list of available permissions for this corporate account. They are used when assigning permissions to corporate users.

• corporate.getCorporate

  View the details of the corporate account that your user account belongs to.

• corporate.getCorporateById

  Get details of this corporate account

• corporate.getCorporatesList

  Get a list of corporate accounts

• corporate.getCorporateUserGroups

  View a list of user groups under my corporate account. User groups are a part of our RBAC implementation and can be used to configure complex permission scenarios.

• corporate.getCorporateUserGroupsById

  Get a list of user groups for this corporate account

• corporate.getCorporateUsers

  View a list of users under your corporate account. This endpoint will only return information if your user account is permitted to view corporate account users, configured by your administrator.

• corporate.getCorporateUsersById

  Get a list of users for this corporate account

• corporate.saveCorporateUser

  Create or update a user under your corporate account. This endpoint requires permissions for corporate user management, configured by your administrator.

• corporate.saveCorporateUserGroup

  Create or update a corporate user group

• corporate.saveCorporateUserGroupById

  Create or update a corporate user group for this corporate account

• document.getAllDocumentSubjects

  Get a list of subjects of projects

• document.getDocument

  View a single document from your MotaWord account with its translation info.

• document.getDocumentProgress

  View the translation or proofreading progress of a document in your account. You can also track the progress of a document under the project that it was ordered with.

• document.getDocuments

  View a list of files and documents that you have translations for. This endpoint lets you view your MotaWord account as a multilingual translated file repository, without needing to go through your projects to interact with files in them.

• document.getSimilarDocuments

  Find documents similar to this document. Optionally, include translation information.

• document.getUserDocuments

  Get a list of your documents

• document.regeneratePreview

  Regenerate preview and return preview URL for given file

• document.useAsDraft

  Use the translation of given source manual document as manual draft source for the given target document.

• document.useAsRegular

  Use the translation of the given manual document as a regular file.

• glossary.createGlossary

  Upload a new glossary file to your project to be used during translation. Glossaries can be CSV or TBX files.

• glossary.deleteGlossary

  Delete the existing glossary from the project.

• glossary.downloadGlobalGlossary

  Download your corporate account's global glossary. This endpoint is available only for corporate account customers. This glossary will be automatically attached to each new project under your account.

• glossary.downloadGlossary

  Download a previously uploaded glossary file.

• glossary.getGlossaries

  View a list of glossaries previously uploaded to the project.

• glossary.getGlossary

  View the details of a glossary file uploaded to a project.

• glossary.updateGlobalGlossary

  Update your corporate account's global glossary. This endpoint is available only for corporate account customers. This glossary will be automatically attached to each new project under your account.

• glossary.updateGlossary

  Update the existing glossary file in the project. Public users are allowed to have only 1 glossary per project and file name and contents will replaced with the new glossary file that you are uploading via this endpoint.

• integrations.getIntegrationsToken

  Generate a new access token for MotaWord's integrations service

• invitation.getInvitationVendors

  Get vendor list for compiled invitation needs

• machineLearning.getDeliveryPrediction

  Get a delivery prediction for a project

• pam.getClientProfileForPam

  Get the Pam profile of a client for this client ID

• pam.getProjectCompletionReportForPam

  Get completion report data of a project

• pam.postMessage

  Sends a message to the channel.

• payment.deleteCreditCard

  Delete credit card

• payment.getCreditCard

  View saved credit card

• payment.resetCardPaymentCode

  Reset the payment code used to bypass credit card payment. This will invalidate your current payment code and your users should be aware of this change while ordering translations.

• payment.resetCorporatePaymentCode

  Reset your corporate account's payment code to bypass credit card payment. This will invalidate your current payment code and your users should be aware of this change while ordering translations.

• payment.toggleCorporateAutoCharge

  Toggle (enable/disable) automatic charges on the credit card on file.

• project.assignCm

  Assign a CM to the project

• project.cancelProject

  If you haven't launched your translation project yet, we will delete it. If MotaWord already started working on your project, we will cancel the project and refund the volume that we haven't worked on yet.

• project.createProject

  Create a new translation project. Projects are not launched (you are not charged) until you /launch the created project.

• project.deleteProject

  If you haven't launched your translation project yet, we will delete it. If MotaWord already started working on your project, we will cancel the project and refund the volume that we haven't worked on yet.

• project.deliverProject

  Deliver project to the owner of the project. You can also download your translations in /package and /download endpoints.

• project.download

  Download the latest translation package. You must have requested a /package call beforehand and wait until the packaging status is 'completed'.

• project.downloadHtmlInvoice

  Download your project invoice as HTML. This is useful when you want to show your users the invoice in a webpage.

• project.downloadLanguage

  Download the latest translation package for your target language. You must have requested a /package call beforehand and wait until the packaging status is 'completed'.

• project.downloadPdfInvoice

  Download your project invoice as PDF. Your invoice may be in "unpaid" status, in which case youn can see the payment instructions in the PDF file.

• project.getInvoice

  View your invoice details for your translation project.

• project.getProgress

  Monitor the translation progress of an already launched project in real-time.

• project.getProject

  View the details of a translation project in your account.

• project.getProjects

  View the translation projects ordered in your account. If you have the related permission (configured by your account administrator), you can view the projects of your colleagues under the same company account.

• project.getProjectVendors

  Get a list of vendors.

• project.getQuoteIdFromInternalId

  Get Quote Id

• project.getVendorProjects

  Get a list of projects that are available to you to work on as a vendor. This is not a list of projects that you ordered as a customer.

• project.getVendorProjectsByUserId

  Get a list of user/vendor projects

• project.launchProject

  Launch your translation project so MotaWord can actually start working on your translation.

• project.package

  Package the translations in your project, prepare translated documents and make it ready to be downloaded. Once packaged, you can download your translated project.

• project.packageLanguage

  Package the translations in your project for a specific target language, prepare translated documents and make it ready to be downloaded. Once packaged, you can download your translated project in this target language.

• project.recreateProject

  Recreate your translation project from scratch. This is a risky action, you will lose current translations.

• project.sendQuoteEmail

  Send a quote email

• project.submitProjectReports

  Submit feedback report for a project

• project.trackPackage

  Track the packaging status of your translations, by using the key from packaging request. Once packaging is completed, you can download your translations via /download endpoints.

• project.triggerCallback

  Trigger a call to your callback URL related to this project.

• project.updateProject

  Update project info and settings

• projectDocument.createProjectDocument

  Upload a new document

• projectDocument.deleteProjectDocument

  Delete the document

• projectDocument.downloadProjectDocument

  Download an actual source file you uploaded to be translated in your project.

• projectDocument.downloadTranslatedDocumentForLanguage

  Download translated document in the given target language.

• projectDocument.getProjectDocument

  View the details of a source file you uploaded to be translated in your project.

• projectDocument.getProjectDocuments

  Get a list of source files you uploaded to be translated in your project.

• projectDocument.updateProjectDocument

  Update the document. File name and contents will replaced with the new one.

• projectWebhooks.deleteProjectWebhook

  Delete project webhooks. Projects currently support registering only 1 webhook. This endpoint deletes the previously registered webhook.

• projectWebhooks.getProjectWebhooks

  This endpoint returns Project entity which contains callback_url field for webhook URL. Currently projects can have only 1 webhook registered.

• projectWebhooks.postProjectWebhook

  Update project webhook URL

• projectWebhooks.updateProjectWebhook

  Update project webhook URL

• report.generateQaReport

  Generate a QA report for given filter

• report.getFilterContents

  Returns available options for selected timeframe.

• report.getLanguagePairsReport

  View translation reports for each language pair with translations under your account. You can view company-wide language pairs if you have the user permission.

• report.getProjectsReport

  View projects under your account, with advanced filtering. You can view company-wide projects if you have the user permission.

• report.getUsersReport

  View translation reports for each user under your company account. You need the permission to view users in your company.

• search.checkDocumentsReindex

  Check reindex status of the client source and translation documents.

• search.reindexDocuments

  Reindex for search all of the client source and translation documents.

• search.searchEverywhere

  Search through everything in your account, from projects to documents, from source strings to translations...

• static.getEndpoints

  The root endpoint will provide you with an OpenAPI definition of MotaWord API.

• static.getFormats

  Get a list of supported formats for documents, style guides and extensions.

• static.getLanguages

  Get a list of supported languages

• static.getSwaggerYaml

  Get Swagger YAML

• stats.getCommissionStats

  Returns the total commissions stats.

• stats.getCommissionStatsByFilter

  Returns the total commissions stats by report filter.

• stats.getPopularPairs

  View your popular language pairs

• stats.getProjectStats

  View your project statistics

• stats.getStringStats

  View your translation statistics

• strings.clearTranslationCache

  Clear/delete continuous project translation cache.

• strings.getContinuousProjectFileStrings

  View the strings from a document and their translations in your continuous translation project, for all target languages. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getContinuousProjectStrings

  View the strings and their translations in your continuous translation project, for all target languages. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getDocumentTranslations

  View the strings and their translations in your translation project for the specified source document. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getDocumentTranslationsForLanguage

  View the strings and their translations in the given target language for the specified source document. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getProjectStrings

  View the strings and their translations in your translation project, for all target languages. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getProjectStringsForLanguage

  View the strings and their translations in your translation project for the specified target language. The list of translations is live if your project is not completed yet. If you need the translated version of your source document/file, then you need to use package and download endpoints.

• strings.getProjectTranslations

  Deprecated. Use /projects/{projectId}/strings instead.

• strings.getProjectTranslationsForLanguage

  Deprecated. use /projects/{projectId}/strings/{language} instead.

• strings.getStrings

  Get a list of all strings and their translations under your account, from all projects. This is your MotaWord translation memory. If you have the related permission, this endpoint will also return strings from your company account.

• strings.getTranslationCache

  MotaWord caches your account intensively (and in a smart way) in real-time translation environments. This endpoint will return the currently cached strings and translations in your continuous translation project.

• strings.packageProjectTranslationMemory

  Package and download project translation memory in TMX format

• strings.packageProjectTranslationMemoryForLanguage

  Package and download project translation memory in TMX format for a specific target language.

• strings.packageProjectTranslationMemoryForLanguageStatus

  Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.

• strings.packageProjectTranslationMemoryStatus

  Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.

• strings.packageUserTranslationMemory

  Package and download account translation memory in TMX format. If you have the related permission, this will also download your company translation memory.

• strings.packageUserTranslationMemoryForLanguageStatus

  Check translation memory packaging status for async packaging requests, using the key returned from strings/package call.

• strings.postContinuousProjectFileStrings

  Get a list of strings and its translations in the project.

• strings.postStrings

  Deprecated, use instant translation mechanism for continuous projects.

• strings.recacheTranslations

  Recache translations for the continuous project.

• strings.updateTranslationMemoryUnit

  Update the translation of a string from your account strings/translation memory.

• styleGuide.createStyleGuide

  Upload a new style guide

• styleGuide.deleteStyleGuide

  Delete the existing style guide from the project.

• styleGuide.downloadGlobalStyleGuide

  Download your account's global style guide. This endpoint is available only for corporate account customers. This style guide will be automatically attached to each new project under your account.

• styleGuide.downloadStyleGuide

  Download a previously uploaded style guide file.

• styleGuide.getStyleGuide

  View the details of a style guide uploaded to a project

• styleGuide.getStyleGuides

  View a list of style guides in your project.

• styleGuide.updateGlobalStyleGuide

  Update your corporate account's global style guide. This endpoint is available only for corporate account customers. This style guide will be automatically attached to each new project under your account.

• styleGuide.updateStyleGuide

  Update the existing style guide in the project. Public users are allowed to have only 1 style guide per project and file name and contents will replaced with the new style guide that you are uploading via this endpoint.

• surveys.getQuestions

  Get survey questions in given scope and type

• surveys.submitAnswers

  Post survey answers for scope and type

• user.approveVendorApplication

  POST /{userId}/approve

• user.createUser

  Create a new platform user

• user.deleteAccount

  Delete your MotaWord account. Be careful; once deleted, you will not have access to MotaWord via API or your dashboards.

• user.deleteUserAccount

  Delete requester account

• user.downgradeProofreader

  POST /downgrade-proofreader

• user.downgradeUserProofreader

  POST /{userId}/downgrade-proofreader

• user.freezeAccount

  Freeze your account temporarily, especially to stop receiving project notifications.

• user.freezeUserAccount

  Freeze requester account for project notifications

• user.getAllVendorTags

  Returns all vendor tags for vendors filter

• user.getEarnings

  View your vendor earnings from your translation activites. Includes real-time earnings from ongoing projects, and fixed earnings from completed projects, as well as total earnings and string edits.

• user.getFilteredVendors

  Get a list of vendors available for the criteria given

• user.getMe

  Get your user information, including client, corporate account and vendor account information.

• user.getPaymentInfo

  Returns billing and saved credit card information for user, and their corporate account if present & allowed.

• user.getPermissions

  View a list of permissions that your user account is authorized for, configured either by default, or by your account administator.

• user.getResponsivity

  View your statistical analysis of responsiveness to our translation projects, invitations, notifications and such.

• user.getStats

  View your client and vendor statistics.

• user.getThisUserGroups

  Returns a list of user groups that this user belongs to.

• user.getUser

  Get user information, including client or vendor specific info.

• user.getUserEarnings

  Returns your vendor earnings. Includes real-time earnings from ongoing projects, and fixed earnings from completed projects. Also includes total earnings and string edits.

• user.getUserGroups

  View the user groups that your user account belongs to. This is typically configured by your account administator's dashboard.

• user.getUserPaymentInfo

  Returns billing and saved credit card information for user, and their corporate account if present & allowed.

• user.getUserPermissions

  Returns a list of permissions that this user is authorized for.

• user.getUserPopularPairs

  Returns the language pairs that the user has ordered most.

• user.getUserProjectStats

  Returns a user's project statistics.

• user.getUserResponsivity

  Returns a user's vendor responsivity stats

• user.getUsers

  Get a list of platform users

• user.getUserStats

  Returns a user's client and vendor statistics. This used to be called "summary" (@deprecated).

• user.logLocation

  Log user's current location. This data is used in our Intelligent Project Manager for various data analysis, including project prioritization for vendors and account validation.

• user.makeProofreader

  POST /make-proofreader

• user.makeUserProofreader

  POST /{userId}/make-proofreader

• user.rejectVendorApplication

  POST /{userId}/reject

• user.sendEmailConfirmation

  Sends email confirmation email for current user

• user.sendPasswordReminder

  Sends password reset email to the user's registered email address

• user.sendUserEmailConfirmation

  Sends email confirmation email for a user

• user.subscribeNotification

  Subscribe to push notifications to receive project and platform notifications.

• user.subscribeUserNotification

  POST /{userId}/notifications/subscribe

• user.suspendUser

  POST /{userId}/suspend

• user.unfreezeAccount

  Reactive your account to start receiving notifications.

• user.unfreezeUserAccount

  Unfreeze requester account for project notifications

• user.unsubscribeNotification

  POST /notifications/unsubscribe

• user.unsubscribeUserNotification

  POST /{userId}/notifications/unsubscribe

• user.updateMe

  Update your account info

• user.updatePassword

  Password should contain at least one uppercase, lowercase character and one number

• user.updatePaymentInfo

  Update your billing and saved credit card information

• user.updateUser

  POST /{userId}

• user.updateUserGroup

  POST /{userId}/user-groups

• user.updateUserPaymentInfo

  Update user's billing and saved credit card information

• user.uploadProfilePicture

  Upload a profile picture on your account. This is used where your profile is mentioned throughout the platform. Your picture is not used publicly.

• user.uploadUserProfilePicture

  POST /{userId}/profile-picture

• vendor.getAvailableVendors

  Get a list of vendors available for the criteria given

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools