openapi-directory/api/motaword.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.motaword.com"},{"url":"https://sandbox.motaword.com"},{"url":"http://localhost"}],"info":{"description":"Use MotaWord API to post and track your translation projects.","title":"MotaWord API","version":"1.0","x-apiClientRegistration":{"url":"https://www.motaword.com/developer/register"},"x-apisguru-categories":["text"],"x-cli-description":"Use MotaWord CLI to interact with your MotaWord account in many ways to manage your translation and localization needs. Visit motaword.com/developer for details.","x-cli-name":"motaword","x-logo":{"url":"https://dentycj2qhk72.cloudfront.net/new/images/new_logo_horizontal.png"},"x-origin":[{"format":"openapi","url":"https://api.motaword.com/swagger","version":"3.0"}],"x-providerName":"motaword.com"},"externalDocs":{"url":"https://www.motaword.com/developer"},"security":[{"mwoAuth":["default"]}],"paths":{"/":{"get":{"description":"The root endpoint will provide you with an OpenAPI definition of MotaWord API.\n","operationId":"getEndpoints","responses":{"200":{"content":{"text/yaml":{"schema":{"type":"object"}}},"description":"YAML representation of our OpenAPI definition."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication error"}},"security":[],"summary":"Available endpoints","tags":["Static"],"x-cli-cmd-group":"static"},"x-internal":true},"/async/download":{"get":{"description":"Download the result of an async operation that you have requested in other endpoints.","operationId":"downloadAsync","parameters":[{"description":"Async operation key","example":"f0db2468-6b77-41a4-bafe-70157bc166ad","in":"query","name":"async_request_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"File"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Download result of an async operation","tags":["Async"],"x-cli-cmd-group":"async"}},"/blogs":{"get":{"operationId":"getBlogPosts","parameters":[{"description":"Article language, default `en`. When no blog article is available and `fallback=true` is specified, it falls back to `en`.","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"When `true`, and no article is found in the locale, it falls back to `locale=en`.","in":"query","name":"fallback","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogArticleList"}}},"description":"List of blog articles"}},"summary":"Get blog posts - ordered by created desc by default","tags":["Blog"],"x-cli-cmd-group":"blog"},"x-internal":true},"/cache/{key}":{"delete":{"operationId":"deleteCache","parameters":[{"description":"Cache key","example":"any key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Clear cache by key"},"x-internal":true},"/commissions":{"get":{"operationId":"getCommissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionList"}}},"description":"Commissions for client."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns a commission list of current client.","tags":["Commission"],"x-cli-cmd-group":"commissions"},"post":{"operationId":"getCommissionsByFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportFilter"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionList"}}},"description":"Commissions for client."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnauthorizedUser"}},"summary":"Returns a commission list of current client.","tags":["Commission"],"x-cli-cmd-group":"commissions"},"x-internal":true},"/continuous_projects":{"get":{"description":"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.","operationId":"getContinuousProjects","parameters":[{"description":"Type of continuous project.","in":"query","name":"type","required":false,"schema":{"default":"active","enum":["active"],"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectsList"}}},"description":"Newly created continuous project"}},"summary":"View continuous projects","tags":["ContinuousProject"],"x-cli-aliases":["list"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Create a new continuous project for your software, website, CI/CD translation needs.","operationId":"createContinuousProject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"Newly created continuous project"}},"summary":"Create a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["create"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}":{"delete":{"description":"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.","operationId":"deleteContinuousProject","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Continuous project deleted successfully"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["delete"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"View the details of a continuous project.","operationId":"getContinuousProject","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"ContinuousProject model"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View a continuous project","tags":["ContinuousProject"],"x-cli-aliases":["get"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Update the details and settings of continuous project.","operationId":"updateContinuousProject","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectUpdateContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProject"}}},"description":"Update continuous project operation status"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update a continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/analytics-token":{"get":{"description":"Get JWT token to be used in analytics dashboards","operationId":"getAnalyticsToken","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsToken"}}},"description":"JWT token result"}},"summary":"Get JWT token to be used in analytics dashboards","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/collect-analytics":{"post":{"description":"Save/collect analytics data from Active widget","operationId":"collectAnalytics","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsCollection"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Analytics data collection result"}},"summary":"Save/collect analytics data from Active widget","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/complete":{"post":{"description":"Complete continuous project","operationId":"complete","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Complete continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/quote":{"post":{"description":"Get a new quote for provided documents in continuous project","operationId":"getQuoteForDocuments","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuotesForDocumentsBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for documents","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/{documentId}/complete":{"post":{"description":"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.","operationId":"completeContinuousDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound FileNotFound DocumentNotFound"}},"summary":"Complete a continuous project document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/documents/{documentId}/quote":{"post":{"description":"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.","operationId":"getQuoteForDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get a quote for a continuous project document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/quote":{"post":{"description":"Get a new quote for provided target languages in continuous project","operationId":"getQuoteForLanguages","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuotesForLanguagesBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for languages","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/{targetLanguage}/complete":{"post":{"description":"Complete continuous project language","operationId":"completeLanguage","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to complete","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation status"}},"summary":"Complete continuous project language","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/languages/{targetLanguage}/quote":{"post":{"description":"Get a new quote for provided target language in continuous project","operationId":"getQuoteForLanguage","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to complete","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}},"description":"Newly created project(s)"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"FileTooLarge FileTooSmall FileWasAlreadyUploaded"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedDocumentFormat UnsupportedStyleGuideFormat UnsupportedGlossaryFormat"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UnsupportedLanguage TooManyGlossaries ProjectAlreadyHasGlossary"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectInsertFailed"}},"summary":"Get quote for language","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"x-internal":true},"/continuous_projects/{id}/subscription":{"delete":{"description":"Delete subscription for continuous project","operationId":"deleteSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Delete continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Delete subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"Get subscription for continuous project","operationId":"getSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Get continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Create subscription for continuous project","operationId":"createSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Newly created continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Create subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"put":{"description":"Update subscription for continuous project","operationId":"updateSubscription","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Updated continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update subscription for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/subscription/payment":{"put":{"description":"Update subscription payment method for continuous project","operationId":"updateSubscriptionPaymentMethod","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Updated continuous project subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"MissingParameter"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Update subscription payment method for continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{id}/translate/{targetLanguage}":{"post":{"description":"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.","operationId":"translate","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Target language that you want to instantly translate your file into.","example":"en-US","in":"path","name":"targetLanguage","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantTranslationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantTranslationResult"}}},"description":"Instant translation result. It may return a list of translated strings, or a list of translated files."}},"summary":"Instantly translate your content","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents":{"get":{"description":"View the documents under this continuous project","operationId":"getContinuousProjectDocuments","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentList"}}},"description":"A list of continuous project document models"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","/continuous_projects/{id}/translate/{targetLanguage}":null}}},"description":"ProjectNotFound"}},"summary":"View continuous documents","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"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.","operationId":"addDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrUpdateDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"The newly added continuous project document object."}},"summary":"Add a new document to your continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/progress":{"post":{"description":"Get continuous project document progress for multiple IDs","operationId":"postContinuousProjectDocumentProgress","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentProgressBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Get continuous project document progress for multiple IDs","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/strings":{"post":{"operationId":"postContinuousProjectFileStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocumentStringsBody"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"Get a list of strings and its translations in the project.","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/documents/{documentId}":{"get":{"description":"View the details of a source document in continuous translation project.","operationId":"getContinuousProjectDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View a continuous document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"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.","operationId":"updateDocument","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Continuous project document ID","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrUpdateDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectDocument"}}},"description":"The updated continuous project document object."}},"summary":"Update the document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/{documentId}/progress":{"get":{"description":"Monitor the translation progress of a document in a continuous project in real-time.","operationId":"getContinuousProjectDocumentProgress","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Progress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Monitor progress of a continuous document","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/documents/{documentId}/strings":{"get":{"description":"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.","operationId":"getContinuousProjectFileStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Document ID/Name","example":179469,"in":"path","name":"documentId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings their translations in a continuous document","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/invoices":{"get":{"description":"Get real-time access to a continuous project's invoices.","operationId":"getContinuousProjectInvoices","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectInvoices"}}},"description":"Invoices List"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Invoices of a continuous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/progress":{"get":{"description":"Monitor the translation progress of an ongoing continuous project in real-time.","operationId":"getContinuousProjectProgress","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"filterByLanguage","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectProgress"}}},"description":"Progress information"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"Monitor progress and status of a continous project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/strings":{"get":{"description":"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.","operationId":"getContinuousProjectStrings","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringList"}}},"description":"Response for strings and their translations"}},"summary":"View strings and translations in continuous project","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/strings/cached":{"delete":{"description":"Clear/delete continuous project translation cache.","operationId":"clearTranslationCache","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Locale","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"Continuous Project File ID","in":"query","name":"file_id","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation response"}},"summary":"Clear translation cache","tags":["Strings"],"x-cli-cmd-group":"strings"},"get":{"description":"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.","operationId":"getTranslationCache","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Flatten cache results and ignore document keys","in":"query","name":"flatten","required":false,"schema":{"default":1,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContinuousProjectCache"}}},"description":"Response for strings and their translations"}},"summary":"View cached strings translations in continuous project","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/strings/recache-tms":{"post":{"description":"Recache translations for the continuous project.","operationId":"recacheTranslations","parameters":[{"description":"Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Locale","in":"query","name":"locale","required":false,"schema":{"type":"string"}},{"description":"Continuous Project File ID","in":"query","name":"file_id","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Operation response"}},"summary":"Recache translations","tags":["Strings"],"x-cli-cmd-group":"strings"}},"/continuous_projects/{projectId}/widgets":{"get":{"description":"View a list of widgets in your Active project to be used in your website. Most website-specific configuration is provided via widgets.","operationId":"getActiveWidgets","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidgetList"}}},"description":"List of widgets"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound"}},"summary":"View Active widgets","tags":["ContinuousProject"],"x-cli-aliases":["widgets"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"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.","operationId":"createActiveWidget","parameters":[{"description":"Continuous project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Create a new Active widget","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/widgets/{widgetId}":{"delete":{"description":"Delete a single widget for this Active project","operationId":"deleteActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Delete operation result"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Delete a single widget for this Active project","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"},"get":{"description":"View the details of an Active widget to be used in your website. Most website-specific configuration is provided via widgets.","operationId":"getActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Active widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound"}},"summary":"View an Active widget","tags":["ContinuousProject"],"x-cli-aliases":["widget"],"x-cli-cmd-group":"continuous-projects"},"post":{"description":"Update Active widget settings.","operationId":"updateActiveWidget","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Update Active widget settings.","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/continuous_projects/{projectId}/widgets/{widgetId}/reset-token":{"post":{"description":"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.","operationId":"resetActiveWidgetToken","parameters":[{"description":"Continuous Project ID","example":74,"in":"path","name":"projectId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Active widget ID belonging to this Continuous Project","example":236,"in":"path","name":"widgetId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveWidget"}}},"description":"Updated widget details"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser"}},"summary":"Reset Active widget token","tags":["ContinuousProject"],"x-cli-cmd-group":"continuous-projects"}},"/corporate":{"get":{"description":"View the details of the corporate account that your user account belongs to.","operationId":"getCorporate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateAccount"}}},"description":"Corporate account details"}},"summary":"View your corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/permissions":{"get":{"description":"View a list of available permissions for your corporate account. They are used when assigning permissions to your corporate users.","operationId":"getAvailableCorporatePermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"View available permissions","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/user-groups":{"get":{"description":"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.","operationId":"getCorporateUserGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"User group list"}},"summary":"View user groups","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a corporate user group","operationId":"saveCorporateUserGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"description":"User group list"}},"summary":"Create or update a corporate user group","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporate/users":{"get":{"description":"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.","operationId":"getCorporateUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"View users","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a user under your corporate account. This endpoint requires permissions for corporate user management, configured by your administrator.","operationId":"saveCorporateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateContent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created or updated user"}},"summary":"Create or update a user","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporates/all":{"get":{"description":"Get a list of corporate accounts","operationId":"getCorporatesList","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CorporateAccount"},"type":"array"}}},"description":"Corporate account list"}},"summary":"Get a list of corporate accounts","tags":["Corporate"],"x-cli-cmd-group":"corporates"}},"/corporates/{corporateId}":{"get":{"description":"Get details of this corporate account","operationId":"getCorporateById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateAccount"}}},"description":"Corporate account details"}},"summary":"Get details of this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/permissions":{"get":{"description":"Get a list of available permissions for this corporate account. They are used when assigning permissions to corporate users.","operationId":"getAvailableCorporatePermissionsById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionList"}}},"description":"List of permission strings"}},"summary":"Get a list of available permissions for this corporate account. They are used when assigning permissions to corporate users.","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/user-groups":{"get":{"description":"Get a list of user groups for this corporate account","operationId":"getCorporateUserGroupsById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupList"}}},"description":"User group list"}},"summary":"Get a list of user groups for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"post":{"description":"Create or update a corporate user group for this corporate account","operationId":"saveCorporateUserGroupById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}},"description":"User group list"}},"summary":"Create or update a corporate user group for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/corporates/{corporateId}/users":{"get":{"description":"Get a list of users for this corporate account","operationId":"getCorporateUsersById","parameters":[{"description":"Corporate ID","example":2,"in":"path","name":"corporateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}},"description":"User list"}},"summary":"Get a list of users for this corporate account","tags":["Corporate"],"x-cli-cmd-group":"corporates"},"x-internal":true},"/delete-account":{"delete":{"description":"Delete your MotaWord account. Be careful; once deleted, you will not have access to MotaWord via API or your dashboards.","operationId":"deleteAccount","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationStatus"}}},"description":"Successful operation"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"UserNotFound"}},"summary":"Delete your account","tags":["User"],"x-cli-cmd-group":"users"}},"/documents":{"get":{"description":"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.","operationId":"getDocuments","parameters":[{"description":"When true, this will return the most 4 recent active documents.","in":"query","name":"recent","required":false,"schema":{"default":0,"type":"boolean"}},{"in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"type_filter","required":false,"schema":{"default":"ALL","enum":["ALL","TEXT_DOCUMENTS","PRESENTATIONS","SPREADSHEETS","PDFS","IMAGES","SUBTITLES","DESIGNS","LOCALIZATION","WEB","STYLE_GUIDES","GLOSSARIES"],"type":"string"}},{"description":"searches in source language of documents, in source and target languages of document's quote","in":"query","name":"language_code","required":false,"schema":{"type":"string"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int64","type":"integer"}},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int64","type":"integer"}},{"in":"query","name":"order_by","required":false,"schema":{"default":"updated_at","enum":["id","updated_at","created_at","name"],"type":"string"}},{"in":"query","name":"order_type","required":false,"schema":{"$ref":"#/components/schemas/ListOrderType","default":"desc"}},{"description":"Attach further information. Possible values 'preview' to fetch temporary preview URLs. This is NOT recommended to be used with list calls. Only use with[]=preview for single document/style guide calls.","in":"query","name":"with[]","required":false,"schema":{"items":{"enum":["preview","editors"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentList"}}},"description":"Document list"}},"summary":"View your documents","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/subjects":{"get":{"description":"Get a list of subjects of projects","operationId":"getAllDocumentSubjects","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DocumentSubjects"},"type":"array"}}},"description":"List of subjects of all projects."}},"summary":"Get a list of subjects of projects","tags":["Document"],"x-cli-cmd-group":"documents"}},"/documents/{documentId}":{"get":{"description