cURL

curl "https://api.phrase.com/v2/projects" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F name=My%20Android%20Project \
  -F main_format=yml \
  -F shares_translation_memory=true

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "my-android-project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "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"
  ]
}

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

cURL

curl "https://api.phrase.com/v2/projects" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F name=My%20Android%20Project \
  -F main_format=yml \
  -F shares_translation_memory=true

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "my-android-project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "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"
  ]
}

Authorizations

Authorization

string

header

required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP

string

Two-Factor-Authentication token (optional)

Body

application/json

name

string

required

Name of the project

Example:

"My Android Project"

main_format

string

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.

Example:

"yml"

media

string

(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.

Example:

"Python"

shares_translation_memory

boolean

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

Example:

true

project_image

file

Image to identify the project

remove_project_image

boolean

Indicates whether the project image should be deleted.

Example:

null

account_id

string

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

Example:

"abcd1234"

point_of_contact

string

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

Example:

"abcd1234"

source_project_id

string

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.

Example:

"abcd1234"

workflow

string

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

Example:

"review"

machine_translation_enabled

boolean

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

Example:

true

enable_branching

boolean

(Optional) Enable branching in the project

Example:

true

protect_master_branch

boolean

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

Example:

true

enable_all_data_type_translation_keys_for_translators

boolean

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

Example:

true

enable_icu_message_format

boolean

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

Example:

true

zero_plural_form_enabled

boolean

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

Example:

true

autotranslate_enabled

boolean

(Optional) Autopilot, requires machine_translation_enabled. Read more

Example:

true

autotranslate_check_new_translation_keys

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_check_new_uploads

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_check_new_locales

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_mark_as_unverified

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_use_machine_translation

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_use_translation_memory

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autotranslate_overwrite_unverified_translations

boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

autocomplete_job_enabled

boolean

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

Example:

false

job_locking_enabled

boolean

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

Example:

false

smart_suggest_enabled

boolean

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

Example:

true

smart_suggest_use_glossary

boolean

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

Example:

true

smart_suggest_use_machine_translation

boolean

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

Example:

true

translation_keys_sort_collation

string

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

Example:

"unicode_ci"

default_encoding

enum<string>

(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.

Available options:

UTF-8,

UTF-16,

UTF-16BE,

UTF-16LE,

ISO-8859-1

Example:

"UTF-8"

cldr_version

string

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

Example:

"cldr48"

placeholder_styles

string[]

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

Example:

["angular", "iOS"]

Response

Created

id

string

name

string

slug

string

main_format

string

project_image_url

string

media

string

account

account · object

Show child attributes

Example:

{
  "id": "abcd1234",
  "name": "Company Account",
  "slug": "company_account",
  "company": "My Awesome Company",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "company_logo_url": "http://assets.example.com/company_logo.png"
}

space

space · object

Show child attributes

Example:

{
  "id": "2e7574e8f2372906a03110c2a7cfe671",
  "name": "My first space",
  "created_at": "2020-02-25T12:17:25Z",
  "updated_at": "2020-03-13T14:46:57Z",
  "projects_count": 2
}

point_of_contact

user_preview · object

Show child attributes

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}

created_at

string<date-time>

updated_at

string<date-time>

shares_translation_memory

boolean

machine_translation_enabled

boolean

Example:

true

zero_plural_form_enabled

boolean

Example:

true

enable_all_data_type_translation_keys_for_translators

boolean

Example:

false

enable_icu_message_format

boolean

Example:

false

enable_branching

boolean

Example:

false

protect_master_branch

boolean

Example:

false

autotranslate_enabled

boolean

Example:

false

autotranslate_check_new_translation_keys

boolean

Example:

false

autotranslate_check_new_uploads

boolean

Example:

false

autotranslate_check_new_locales

boolean

Example:

false

autotranslate_mark_as_unverified

boolean

Example:

false

autotranslate_use_machine_translation

boolean

Example:

false

autotranslate_use_translation_memory

boolean

Example:

true

autotranslate_overwrite_unverified_translations

boolean

Example:

false

autocomplete_job_enabled

boolean

Example:

false

default_encoding

string

Example:

"UTF-8"

cldr_version

string

Example:

"legacy"

job_locking_enabled

boolean

Example:

false

placeholder_styles

string[]

Example:

["angular", "iOS"]

branch

branch · object

Show child attributes

Example:

{
  "name": "new-branch",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "merged_at": "2015-01-28T09:52:53Z",
  "merged_by": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "created_by": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "state": "success",
  "child_branches": ["feature_2", "feature_3"]
}

List projects Get a single project

⌘I