Create Project

Create new Crowdin project.

Request

POST http://api.crowdin.net/api/account/create-project?account-key={account-key}

Parameters

Name Value Description
account-keyrequired string Crowdin account API key.
loginrequired string Your Crowdin Account login name.
namerequired string Project name.
identifierrequired string Project identifier. Should be unique among other Crowdin projects.
source_languagerequired string Source files language. Should be a two letters language code.
languagesrequired array An array of language codes project should be translate to.
join_policyrequired string Project join policy. Acceptable values are:
  • open
  • private
language_access_policy optional string Defines how project members can access target languages. Acceptable values are:
  • "open" - any translator can access any language. (default)
  • "moderate" - translator should be granted with access to certain language.
hide_duplicatesoptional bool Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically. Acceptable values are: 1 or 0.
export_approved_onlyoptional bool If set to 1 only approved translations will be exported to resulted ZIP file. Acceptable values are: 1 or 0.
public_downloadsoptional bool Defines whether "Download" button is visible to everyone on Crowdin webpages. Acceptable values are: 1 or 0.
logooptional file Project logo at Crowdin.
cnameoptional string Custom domain name for Crowdin project.
descriptionoptional string Project description.
webhook_file_translatedoptional string Open this URL when one of the project files is translated. URL will be opened with "project" - project identifier, "language" - language code, "file_id" - Crowdin file identifier and "file" - file name.
webhook_file_proofreadoptional string Open this URL when one of the project files is proofread. URL will be opened with "project" - project identifier, "language" - language code, "file_id" - Crowdin file identifier and "file" - file name.
webhook_project_translatedoptional string Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
webhook_project_proofreadoptional string Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.
jsonoptional string May not contain value. Defines that response should be in JSON format.
jsonpoptional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifierrequired string Should contain the project identifier.

Response

If the method is successful, it responds with an XML structure, as shown below (when language_access_policy = open). 
<?xml version="1.0" encoding="ISO-8859-1"?>

  1
  http://translate.example.com/project/test-project-api/invite
  http://translate.example.com/project/test-project-api
  ca51cef8f852425496b1cdd3e86fea88

Response example for projects with "Moderate" language_access_policy. 
<?xml version="1.0" encoding="ISO-8859-1"?>

  1
  
    
      Ukrainian
      http://translate.example.com/project/test-project-api/invite?d=7585662585d5d32307d3937373
      http://translate.example.com/project/test-project-api/invite?d=3585k635r4d5d32307d3937373
    
  
  http://crowdin.net/project/test-project-api
  d13720ba72204273af0321ca980945ec

Unsuccessful response sample: 
<?xml version="1.0" encoding="ISO-8859-1"?>

  12
  Account key is invalid

Examples

curl \
  -F "login=admin" \
  -F "logo=@logo.png" \
  -F "name=This is a test project" \
  -F "identifier=test-project-api" \
  -F "description=Brief Description" \
  -F "hide_duplicates=1" \
  -F "cname=translate.example.com" \
  -F "join_policy=open" \
  -F "languages[]=fr" \
  -F "languages[]=ru" \
  -F "export_approved_only=1" \
  -F "public_downloads=1" \
  -F "source_language=en" \
  http://api.crowdin.net/api/account/create-project?account-key={account-key}

API Methods

Related articles