Create a new project

How to create a project using the API

https://api.platform.sandbox.easytranslate.com/api/v1/teams/:team_identifier/projects

In order to create a new Project, you need to be authenticated and therefore pass your access token in the header of the request. 

You also have to use the following path variable in the endpoint:

• • team_identifier: It can be retrieved from the api/v1/user endpoint. The team_identifier is used to identify the account in which this project should be created. 

you then need to pass a JSON object including the following attributes: 

• • type (project): The type of the data object sent. Type is always “project”
  • source_language (string): This is the language the content is written into. It must follow ISO 639-1 and/or ISO 3166-1 (RFC 5646 and RFC 4647) 

To find the appropriate source language code to use, you can refer to the following table :

• • target_languages (array): Here should be added the array of the languages the content should be translated into. You can have either one target language or multiples. As the source_language, each language must follow ISO 639-1 and/or ISO 3166-1 (RRC 5646 AND rfc 4647). Please note that target_languages shouldn’t contain the same value as source_language and might not use the same language codes. You can refer to the following table to find the appropriate code to use based on the language you need, but keep in mind that you are not allowed to use target_languages that are not provided by your team of translators.

• • callback_url (string): If provided, a webhook call will be triggered to this URL when each of the translations is completed.  You are not required to provide a callback_url, it is optional
  • content (string): This is where the content you wish to be translated must be placed. It must be a valid Json object. 
  • workflow (string): You have the possibility to choose between 3 different workflows (translation, translation+review, self+machine_translation). Note that if not provided, the default workflow is “translation”.

The Human Translation workflow is when a translator is assigned to translate the content you are providing, the Translation + Review is similar to the translation workflow with the difference that another translator is added to the workflow to review the translation of the translated content once the translation is done and finally, you have the Machine Translation workflow where you are using the machine translation feature provided by EasyTranslate without using any translators.

• • folder_id (string): If you already have a designated folder for the project, This is where the existing folder ID needs to be added. You are not required to provide a folder ID, it is optional
  • folder_name (string): By providing a folder_name, you will create a folder to store this project. You are not required to provide a folder name, it is optional
  • name (string): You have the option to use a description name for the project, if a name is not provided, a default name will be used. You are not required to provide a  name, it is optional