--- agentTools: projectIndex: https://motaword.readme.io/llms.txt --- # Create a project [block:callout] { "type": "success", "title": "Creating and launching a project", "body": "Creating a project is preparing your project to launch. Think of it like getting a quote. Until you [launch the project](https://motaword.readme.io/docs/start-a-project), your translation project will not begin and you won't be charged for it." } [/block] [block:api-header] { "type": "basic", "title": "Languages" } [/block] Every translation project must have a language pair: 1 source language , 1 or more target languages. These two fields are the only required parameters of creating a new project. To get a list of language codes, see [Supported languages](https://motaword.readme.io/docs/supported-languages). [block:api-header] { "type": "basic", "title": "Project files" } [/block] Translation projects consist of 3 different files: documents, style guides, glossaries. **[Documents](https://motaword.readme.io/docs/list-documents)** are the files that will be translated. Before you *launch* a project, it must have at least 1 document. On the other hand, **[style guides](https://motaword.readme.io/docs/list-style-guides)** and **[glossaries](https://motaword.readme.io/docs/list-glossaries)** are optional. If you provide, they will definitely increase the quality and speed of your projects. You can either upload these files while creating a project, or you can later upload them via their own API endpoints, such as in [Upload a document](https://motaword.readme.io/docs/upload-a-document) section. [block:callout] { "type": "info", "body": "To get a list of supported file formats for documents, style guides and glossaries, see \"[Supported formats](https://motaword.readme.io/docs/supported-formats)\" section.", "title": "Supported file formats" } [/block] [block:callout] { "type": "info", "title": "Uploading files as form data", "body": "See **Upload a document**, **Upload a style guide** or **Upload a glossary** sections to learn more about how to upload your files directly as an array of form data, rather than an array of file handles." } [/block] [block:api-header] { "type": "basic", "title": "Callback URL and custom data" } [/block] A **callback URL** is an internet address that we will notify about project updates. For example when a project's translation is complete, you will get a "translated" action; same for "proofread" and "completed" statuses. To learn more, see the section "Web Hooks". And a piece of **custom data** is an information you want to receive with your project anytime you ask it. When you get details of your project, or on the web hooks you have, this custom data will always be presented to you for mutual data communication. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "API Settings", "version": "1.5.2" }, "servers": [ { "url": "https://api.motaword.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "access_token", "in": "query", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/projects": { "post": { "summary": "Create a project", "description": "", "operationId": "create-a-project", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "source_language", "target_languages" ], "properties": { "source_language": { "type": "string", "description": "Language code. Source language of your translation project." }, "target_languages": { "type": "array", "description": "Array of language codes. Target language(s) that you want your source language to be translated into.", "items": { "type": "string" } }, "documents": { "type": "array", "description": "Optional. Array of file type parameters. A list of documents to be translated.", "items": { "type": "string" } }, "styleguides": { "type": "array", "description": "Optional. Array of file type parameters. A list of style guides to be presented to the vendors.", "items": { "type": "string" } }, "glossaries": { "type": "array", "description": "Optional. Array of file type parameters. A list of glossaries to accompany the translation project. Currently, only 1 glossary is accepted.", "items": { "type": "string" } }, "callback_url": { "type": "string", "description": "An absolute URL to receive hook notifications about your project." }, "custom": { "type": "array", "description": "Any custom data to store with your project. This parameter will always be presented with the project model, wherever it appears. Arrays are accepted.", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 1,\n \"source_language\": \"string\",\n \"target_languages\": [\n \"string\"\n ],\n \"word_count\": 123,\n \"price\": {\n \"amount\": 1.00,\n \"currency\": \"usd\"\n },\n \"status\": \"string\",\n \"delivery_at\": 1553880303,\n \"valid_until\": 1553880303,\n \"callback_url\": \"string\",\n \"custom\": {},\n \"created_at\": 1553880303,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.motaword.com/v0/projects/1\"\n },\n \"documents\": {\n \"href\": \"https://api.motaword.com/v0/projects/1/documents\"\n },\n \"styleguides\": {\n \"href\": \"https://api.motaword.com/v0/projects/1/styleguides\"\n },\n \"glossaries\": {\n \"href\": \"https://api.motaword.com/v0/projects/1/glossaries\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "source_language": { "type": "string", "example": "string" }, "target_languages": { "type": "array", "items": { "type": "string", "example": "string" } }, "word_count": { "type": "integer", "example": 123, "default": 0 }, "price": { "type": "object", "properties": { "amount": { "type": "integer", "example": 1, "default": 0 }, "currency": { "type": "string", "example": "usd" } } }, "status": { "type": "string", "example": "string" }, "delivery_at": { "type": "integer", "example": 1553880303, "default": 0 }, "valid_until": { "type": "integer", "example": 1553880303, "default": 0 }, "callback_url": { "type": "string", "example": "string" }, "custom": { "type": "object", "properties": {} }, "created_at": { "type": "integer", "example": 1553880303, "default": 0 }, "links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.motaword.com/v0/projects/1" } } }, "documents": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.motaword.com/v0/projects/1/documents" } } }, "styleguides": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.motaword.com/v0/projects/1/styleguides" } } }, "glossaries": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.motaword.com/v0/projects/1/glossaries" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"code\": \"FileTooLarge\",\n \"http_code\": 400,\n \"message\": \"FileTooLarge\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"FileTooSmall\",\n \"http_code\": 400,\n \"message\": \"FileTooSmall\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"FileWasAlreadyUploaded\",\n \"http_code\": 400,\n \"message\": \"FileWasAlreadyUploaded\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}" } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"code\": \"InvalidApiClient\",\n \"http_code\": 401,\n \"message\": \"Your access token is wrong.\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "InvalidApiClient" }, "http_code": { "type": "integer", "example": 401, "default": 0 }, "message": { "type": "string", "example": "Your access token is wrong." }, "help": { "type": "string", "example": "https://www.motaword.com/developer/support" } } } } } } } }, "405": { "description": "405", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"code\": \"UnsupportedDocumentFormat\",\n \"http_code\": 405,\n \"message\": \"UnsupportedDocumentFormat\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"UnsupportedStyleGuideFormat\",\n \"http_code\": 405,\n \"message\": \"UnsupportedStyleGuideFormat\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"UnsupportedGlossaryFormat\",\n \"http_code\": 405,\n \"message\": \"UnsupportedGlossaryFormat\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}" } } } } }, "406": { "description": "406", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"code\": \"UnsupportedLanguage\",\n \"http_code\": 406,\n \"message\": \"UnsupportedLanguage\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"TooManyGlossaries\",\n \"http_code\": 406,\n \"message\": \"TooManyGlossaries\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}\n{\n \"error\": {\n \"code\": \"ProjectAlreadyHasGlossary\",\n \"http_code\": 406,\n \"message\": \"ProjectAlreadyHasGlossary\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}" } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"code\": \"ProjectInsertFailed\",\n \"http_code\": 500,\n \"message\": \"ProjectInsertFailed\",\n \"help\": \"https://www.motaword.com/developer/support\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "example": "ProjectInsertFailed" }, "http_code": { "type": "integer", "example": 500, "default": 0 }, "message": { "type": "string", "example": "ProjectInsertFailed" }, "help": { "type": "string", "example": "https://www.motaword.com/developer/support" } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "6305402c9807941f67a92eb7:55202884504fd6230022adec" } ```