PHphrase
Projects

Create a project

Create a new project in the given account.

When source_project_id is supplied, the new project is created as a clone of that project. All locales, keys, and translations are copied asynchronously after the response is returned, so they may not be available immediately. Settings from the source project are inherited unless explicitly overridden in the request; in clone mode, the shares_translation_memory field is ignored and inherited from the source.

shares_translation_memory defaults to true when omitted on a non-clone create.

post/projects

Request

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

namestring required

Name of the project

main_formatstring

Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see Format Guide or our Formats API Endpoint.

mediastring

(Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: Ruby, JavaScript, AngularJS, React, iOS, Android, Python, PHP, Java, Go, Windows Phone, Rails, Node.js, .NET, Django, Symfony, Yii Framework, Zend Framework, Apple App Store Description, Google Play Description, but it can also take any other value.

shares_translation_memoryboolean

Indicates whether the project should share the account's translation memory

project_imagestring binary

Image to identify the project

remove_project_imageboolean

Indicates whether the project image should be deleted.

account_idstring

Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.

point_of_contactstring

(Optional) User ID of the point of contact for the project.

source_project_idstring

When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params.

workflowstring

(Optional) Review Workflow. "simple" / "review". Read more

machine_translation_enabledboolean

(Optional) Enable machine translation support in the project. Required for Pre-Translation

enable_branchingboolean

(Optional) Enable branching in the project

protect_master_branchboolean

(Optional) Protect the master branch in project where branching is enabled

enable_all_data_type_translation_keys_for_translatorsboolean

(Optional) Otherwise, translators are not allowed to edit translations other than strings

enable_icu_message_formatboolean

(Optional) We can validate and highlight your ICU messages. Read more

zero_plural_form_enabledboolean

(Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.

autotranslate_enabledboolean

(Optional) Autopilot, requires machine_translation_enabled. Read more

autotranslate_check_new_translation_keysboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_check_new_uploadsboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_check_new_localesboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_mark_as_unverifiedboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_use_machine_translationboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_use_translation_memoryboolean

(Optional) Requires autotranslate_enabled to be true

autotranslate_overwrite_unverified_translationsboolean

(Optional) Requires autotranslate_enabled to be true

autocomplete_job_enabledboolean

(Optional) Enable autocomplete-job behavior so that newly created keys and locales are automatically added to in-progress jobs.

job_locking_enabledboolean

(Optional) When enabled, translations are locked once a job moves into review.

smart_suggest_enabledboolean

(Optional) Enable Smart Suggest for the project. Defaults to true when omitted.

smart_suggest_use_glossaryboolean

(Optional) Allow Smart Suggest to source suggestions from the project glossary. Defaults to true when omitted.

smart_suggest_use_machine_translationboolean

(Optional) Allow Smart Suggest to source suggestions from machine translation. Defaults to true when omitted.

translation_keys_sort_collationstring

(Optional) Collation used when sorting translation keys alphabetically. Defaults to unicode_ci when omitted.

default_encoding'UTF-8' | 'UTF-16' | 'UTF-16BE' | 'UTF-16LE' | 'ISO-8859-1'

(Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the file_encoding parameter for Uploads.

cldr_versionstring

(Optional) CLDR plural-rule version used by the project.

placeholder_stylesstring[]

(Optional) List of placeholder styles enabled for the project.

Example request

{
  "name": "My Android Project",
  "main_format": "yml",
  "media": "Python",
  "shares_translation_memory": true,
  "project_image": "/path/to/my/project-screenshot.png",
  "account_id": "abcd1234",
  "point_of_contact": "abcd1234",
  "source_project_id": "abcd1234",
  "workflow": "review",
  "machine_translation_enabled": true,
  "enable_branching": true,
  "protect_master_branch": true,
  "enable_all_data_type_translation_keys_for_translators": true,
  "enable_icu_message_format": true,
  "zero_plural_form_enabled": true,
  "autotranslate_enabled": true,
  "autotranslate_check_new_translation_keys": true,
  "autotranslate_check_new_uploads": true,
  "autotranslate_check_new_locales": true,
  "autotranslate_mark_as_unverified": true,
  "autotranslate_use_machine_translation": true,
  "autotranslate_use_translation_memory": true,
  "autotranslate_overwrite_unverified_translations": true,
  "smart_suggest_enabled": true,
  "smart_suggest_use_glossary": true,
  "smart_suggest_use_machine_translation": true,
  "translation_keys_sort_collation": "unicode_ci",
  "default_encoding": "UTF-8",
  "cldr_version": "cldr48",
  "placeholder_styles": [
    "angular",
    "iOS"
  ]
}

Response

Created

idstring
namestring
slugstring
main_formatstring
project_image_urlstring
mediastring
created_atstring date-time
updated_atstring date-time
shares_translation_memoryboolean
machine_translation_enabledboolean
zero_plural_form_enabledboolean
enable_all_data_type_translation_keys_for_translatorsboolean
enable_icu_message_formatboolean
enable_branchingboolean
protect_master_branchboolean
autotranslate_enabledboolean
autotranslate_check_new_translation_keysboolean
autotranslate_check_new_uploadsboolean
autotranslate_check_new_localesboolean
autotranslate_mark_as_unverifiedboolean
autotranslate_use_machine_translationboolean
autotranslate_use_translation_memoryboolean
autotranslate_overwrite_unverified_translationsboolean
autocomplete_job_enabledboolean
default_encodingstring
cldr_versionstring
job_locking_enabledboolean
placeholder_stylesstring[]

Example response

{
  "slug": "my-android-project",
  "shares_translation_memory": true,
  "machine_translation_enabled": true,
  "zero_plural_form_enabled": true,
  "enable_all_data_type_translation_keys_for_translators": false,
  "enable_icu_message_format": false,
  "enable_branching": false,
  "protect_master_branch": false,
  "autotranslate_enabled": false,
  "autotranslate_check_new_translation_keys": false,
  "autotranslate_check_new_uploads": false,
  "autotranslate_check_new_locales": false,
  "autotranslate_mark_as_unverified": false,
  "autotranslate_use_machine_translation": false,
  "autotranslate_use_translation_memory": true,
  "autotranslate_overwrite_unverified_translations": false,
  "autocomplete_job_enabled": false,
  "default_encoding": "UTF-8",
  "cldr_version": "legacy",
  "job_locking_enabled": false,
  "placeholder_styles": [
    "angular",
    "iOS"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.