Projects

Add Project

Required scopes: project.settings (Read and Write).

post/projects

Request

Base URL
https://api.crowdin.com/api/v2
Auth
none declared
TypeScript
https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/projects/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Project Name

identifierstring

Project Identifier

type0 | 1

Defines the project type. To create a string-based project, type should be set to 1.

sourceLanguageIdstring required

Source Language Identifier. Get via List Supported Languages

targetLanguageIdsstring[]

Target Languages Identifiers. Get via List Supported Languages

visibility'open' | 'private'

Defines how users can join the project. Available values:

open – anyone can join the project
private – only invited users can join the project

languageAccessPolicy'open' | 'moderate'

Defines access to project languages. Available values:

open – each project user can access all project languages
moderate – users should join each project language separately

cnamestring

Custom domain name

descriptionstring

Project description

tagsDetection0 | 1 | 2

Values available:

0 - Auto
1 - Count tags
2 - Skip tags

isMtAllowedboolean

Allows machine translations (Microsoft Translator, Google Translate) be visible for translators in the Editor.

taskBasedAccessControlboolean

Allow project members work with tasks they assigned to, even if they do not have full access to the language.

autoSubstitutionboolean

Allows auto-substitution

autoTranslateDialectsboolean

Automatically fill in regional dialects.

If true, all untranslated strings in regional dialects (e.g. Argentine Spanish) will automatically include translations completed in the primary language (e.g. Spanish).

publicDownloadsboolean

Allows translators to download source files to their machines and upload translations back into the project. Project owner and managers can always download sources and upload translations.

hiddenStringsProofreadersAccessboolean

Allows proofreaders to work with hidden strings. Project owner and managers can always access hidden strings

useGlobalTmboolean

If true - machine translations from connected MT engines (e.g. Microsoft Translator, Google Translate) will appear as suggestions in the Editor.

Note: If your organization plan is free or opensource - default value of this one will be true

showTmSuggestionsDialectsboolean

If true - show primary language TM suggestions for dialects if there are no dialect-specific ones.

tmApprovedSuggestionsOnlyboolean

If true - only approved suggestions will be saved to the project default TM.

skipUntranslatedStringsboolean

Defines whether to skip untranslated strings

exportApprovedOnlyboolean

Defines whether to export only approved strings

qaCheckIsActiveboolean

If true - QA checks are active

glossaryAccessboolean

Allow project members to manage glossary terms. The project owner and managers always can add and edit terms.

glossaryAccessOption'readOnly' | 'fullAccess' | 'manageDrafts'

Defines how project members will manage glossary terms. The project owner and managers always can add and edit terms.

normalizePlaceholderboolean

Enable the transformation of the placeholders to the unified format to improve the work with TM suggestions

preTranslationAiPromptIdinteger

AI Prompt ID to be used as prompt for AI auto-translation as default value

editorSuggestionAiPromptIdinteger

AI Prompt ID to be used as prompt for AI Suggestion action in Editor

qaCheckActionAiPromptIdinteger

AI Prompt ID to be used as prompt for QA check action

contextReviewAiPromptIdinteger

AI Prompt ID to be used as prompt for Advisor string context review

savingsReportSettingsTemplateIdinteger

Report Settings Templates Identifier. Get via List Report Settings Templates

defaultTmIdinteger

Translation Memory ID. If omitted new translation memory will be created. Get via List TMs

defaultGlossaryIdinteger

Glossary ID. If omitted new Glossary will be created. Get via List Glossaries

assignedStyleGuidesinteger[]

Style Guide IDs to assign to project. Get via List Style Guides

inContextboolean

Enable In-Context translations.

Note: Must be used together with inContextPseudoLanguageId

inContextProcessHiddenStringsboolean

Export hidden strings via pseudo-language.

Note: If true - hidden strings included in the pseudo-language archive will be translatable via In-Context.

inContextPseudoLanguageIdstring

In-Context pseudo-language id.

Note: Must be different from project source and target languages

Example request

{
  "name": "Knowledge Base",
  "identifier": "1f198a4e907688bc65834a6d5a6000c3",
  "type": 1,
  "sourceLanguageId": "en",
  "targetLanguageIds": [
    "es"
  ],
  "visibility": "private",
  "languageAccessPolicy": "moderate",
  "cname": "my-custom-domain.crowdin.com",
  "description": "Articles and tutorials",
  "tagsDetection": 1,
  "autoTranslateDialects": true,
  "publicDownloads": true,
  "showTmSuggestionsDialects": true,
  "exportApprovedOnly": true,
  "qaCheckIsActive": true,
  "qaCheckCategories": {
    "empty": true,
    "size": true,
    "tags": true,
    "spaces": true,
    "variables": true,
    "punctuation": true,
    "symbolRegister": true,
    "specialSymbols": true,
    "wrongTranslation": true,
    "spellcheck": true,
    "icu": true,
    "terms": true,
    "duplicate": true,
    "ftl": true,
    "android": true,
    "numbers": true,
    "ai": true,
    "outdated": true,
    "mdx": true,
    "unifiedPlaceholders": true
  },
  "qaChecksIgnorableCategories": {
    "size": true,
    "tags": true,
    "spaces": true,
    "variables": true,
    "punctuation": true,
    "symbolRegister": true,
    "specialSymbols": true,
    "wrongTranslation": true,
    "spellcheck": true,
    "terms": true,
    "android": true,
    "numbers": true,
    "ai": true,
    "outdated": true
  },
  "languageMapping": {
    "uk": {
      "name": "Ukranian",
      "two_letters_code": "ua",
      "three_letters_code": "ukr",
      "locale": "uk-UA",
      "locale_with_underscore": "uk_UA",
      "android_code": "uk-rUA",
      "osx_code": "ua.lproj",
      "osx_locale": "ua"
    }
  },
  "glossaryAccessOption": "readOnly",
  "normalizePlaceholder": true,
  "tmPreTranslate": {
    "enabled": true,
    "autoApproveOption": "all",
    "minimumMatchRatio": "perfect"
  },
  "mtPreTranslate": {
    "enabled": true,
    "mts": [
      {
        "mtId": 1,
        "languageIds": [
          "uk"
        ]
      }
    ]
  },
  "aiPreTranslate": {
    "enabled": true,
    "aiPrompts": [
      {
        "aiPromptId": 1,
        "languageIds": [
          "uk"
        ]
      }
    ]
  },
  "preTranslationAiPromptId": 11,
  "editorSuggestionAiPromptId": 13,
  "qaCheckActionAiPromptId": 8,
  "contextReviewAiPromptId": 11,
  "defaultTmId": 1,
  "defaultGlossaryId": 1,
  "assignedStyleGuides": [
    1
  ],
  "inContext": true,
  "inContextProcessHiddenStrings": true,
  "inContextPseudoLanguageId": "uk"
}

Response

Project was successfully created

Example response

{
  "data": {
    "id": 8,
    "type": 1,
    "userId": 6,
    "sourceLanguageId": "en",
    "targetLanguageIds": [
      "es"
    ],
    "languageAccessPolicy": "moderate",
    "name": "Knowledge Base",
    "cname": "my-custom-domain.crowdin.com",
    "identifier": "1f198a4e907688bc65834a6d5a6000c3",
    "description": "Vault of all terms and their explanation",
    "visibility": "private",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAYAAAA8AXHiAAAGm0lEQVR4nO3cWVCVdRjH8R+HTQQR93BJo1Jz1MrRSS21JDUNRWUxMabVpvXcNuNdl100U2qNuQ+KIiCCCIqYoSPkbiippCKiuBDKvp6FLmzG8Pxf1vO858D7+1z6vA7PMN85Oud//scj0rymBUROZnL1AtQ7MSwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEiEl6sXkLThu2+Vfx6Xmom8C5fEfu7bM6Yh8p25ytmjyip8v3knqmpqxX6+O+ArlpNNmzQBy+e/pZzV1tXjx7g9vT4qgGE51fiQ0fhg6SKYTB4Os8amZqyPT0bZwwoXbKY/huUko4KH4fP3lsPLy9NhZrXa8OuefSguveeCzVyDYTnBkIFB+Ob9KPTx9XGY2e0t2L4vA1duFOu/mAsxrG7q598X5tgVCAzwV84TDx7B2YIrOm/legyrG3x9vGGOjcaQgUHKecaxXOScPq/zVu6BYXWRyeSBL1ZGYFTwMOX8+Nk/kX70hM5buQ+G1UUfRyzG+JDRytn5y4XYfSBL543cC8PqguiFoZg68SXlrPBmCbYk70dLi85LuRmG1UkL3piOudOnKmcld+/jl13JsNnsOm/lfhhWJ0x/eSKWzZujnJU9rMC6nUloarbovJV7YlgdNPHFEMSGL1TOqmpq8VNcAmrq6nXeyn0xrA4YMyIYn0Uvhaen46+rvqERa3ck4mFltQs2c18Mqx1DBw3A16si4ePj7TCzWKz4eddelD74xwWbuTeG1YbAAH+YY1cgwL+vw8xms2NTUhpulNxxwWbuj2Fp6OPrA3NsNAYP6K+cx6cfwsXC6zpv1XMwLAVPTxO+jInAyGeGKuf7so+JflCwN2BYCp9ELsHYMc8qZ0f+OIOsEyd13qjnYVhPWRk2H1MmjFPOTuYXIPnQUZ036pkY1v8smj0Tc6a9qpwVXCtCXGqmzhv1XAzrP69PmYwlobOUs6LbpdiQkAK73eAHgJ3AsABMHvcCYsIWKGd3y8qxbmcSrFabzlv1bIYPK2TUCKyOCle+q15ZXYO1OxLR0Njkgs16NkOHFTxkEL6KiYC3t/p6pa+PDzwVN26ofYYNKyiwH8yx0fDv66f5jF8fX3waFa68zkVtM2RY/n5+MMdGY0D/wHaffW7kcISHztZhq97FkGEtmTsLw4cO7vDz82a+pvkxZFIzZFiq/1MVl95D0e1S5fMmkwc+Wh7W5j+b1Johw3ra5es38cO2XdiUtB919Q3KZ/r3C8CHy97VebOey/BhncwvwPr4JFgsVlRUVSMu7aDms5PGPo9Qjc+7U2uGDutw7ilsT8lo9Y56/tVr+P3UOc2/s2zem5qfeqAnDBmW3d6CPZlHkHI4RzlPzjqKkrv3lTMvL0+sjgrXfO+LHjNkWBk5uW2+KtlsdmxMTNV8x33Y4IGICZsvtV6vYMiwKqrbv/hQXlGF+HTt28wzXpmkeWmVDBpWR50tuIIT5/I156sWL8CgoPbfZDUihtWOhMxszVs4PPLRxrDaYbXasDExFc0aN5x55KPGsDrgQfkjJGRma8555OOIYXVQ3oVLOH3xL+WMRz6OGFYn7Nh/CA/KHylnPPJpjWF1gsVixaakNFgsVuWcRz5PMKxOunO/DMlZ2lfAeOTzGMPqgmNnLuD85ULljEc+jzGsLopLzUR5RZVyxiMfhtVljU3N2JyUpnktzOhHPgyrG4pL7yHtt+OacyMf+TCsbsrOO41Lf99Qzox85MOwnGBbygFUVtcoZ0Y98mFYTlDf0IgtyemaX8NtxCMfhuUk127dRkZOrnJmxCMfhuVEmcfzcLXolnJmtCMfhuVkW/emo7q2Tjkz0pEPw3Ky6to6bN2brvldWkY58mFYAq4W3cLhXPX3lBrlyMcj0ryGX1NHTsdXLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSATDIhEMi0QwLBLBsEgEwyIRDItEMCwSwbBIBMMiEQyLRDAsEsGwSMS//tClrE3peLcAAAAASUVORK5CYII=",
    "publicDownloads": true,
    "createdAt": "2019-09-20T11:34:40+00:00",
    "updatedAt": "2019-09-20T11:34:40+00:00",
    "lastActivity": "2019-09-20T11:34:40+00:00",
    "sourceLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "bcp47Code": "b+es+ES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "pluralCategoryNames": [
        "one"
      ],
      "pluralRules": "(n != 1)",
      "pluralExamples": [
        "0, 2-999; 1.2, 2.07..."
      ],
      "textDirection": "ltr",
      "dialectOf": "es"
    },
    "targetLanguages": [
      {
        "id": "es",
        "name": "Spanish",
        "editorCode": "es",
        "twoLettersCode": "es",
        "threeLettersCode": "spa",
        "locale": "es-ES",
        "androidCode": "es-rES",
        "bcp47Code": "b+es+ES",
        "osxCode": "es.lproj",
        "osxLocale": "es",
        "pluralCategoryNames": [
          "one"
        ],
        "pluralRules": "(n != 1)",
        "pluralExamples": [
          "0, 2-999; 1.2, 2.07..."
        ],
        "textDirection": "ltr",
        "dialectOf": "es"
      }
    ],
    "webUrl": "https://crowdin.com/project/some-project",
    "savingsReportSettingsTemplateId": 1,
    "translateDuplicates": 2,
    "glossaryAccessOption": "readOnly",
    "hiddenStringsProofreadersAccess": true,
    "autoSubstitution": true,
    "autoTranslateDialects": true,
    "showTmSuggestionsDialects": true,
    "qaCheckIsActive": true,
    "qaCheckCategories": {
      "empty": true,
      "size": true,
      "tags": true,
      "spaces": true,
      "variables": true,
      "punctuation": true,
      "symbolRegister": true,
      "specialSymbols": true,
      "wrongTranslation": true,
      "spellcheck": true,
      "icu": true,
      "terms": true,
      "duplicate": true,
      "ftl": true,
      "android": true,
      "numbers": true,
      "ai": true,
      "outdated": true,
      "mdx": true,
      "unifiedPlaceholders": true
    },
    "qaChecksIgnorableCategories": {
      "size": true,
      "tags": true,
      "spaces": true,
      "variables": true,
      "punctuation": true,
      "symbolRegister": true,
      "specialSymbols": true,
      "wrongTranslation": true,
      "spellcheck": true,
      "terms": true,
      "android": true,
      "numbers": true,
      "ai": true,
      "outdated": true
    },
    "languageMapping": {
      "uk": {
        "name": "Ukranian",
        "two_letters_code": "ua",
        "three_letters_code": "ukr",
        "locale": "uk-UA",
        "locale_with_underscore": "uk_UA",
        "android_code": "uk-rUA",
        "osx_code": "ua.lproj",
        "osx_locale": "ua"
      }
    },
    "notificationSettings": {
      "translatorNewStrings": true
    },
    "defaultTmId": 1,
    "defaultGlossaryId": 1,
    "assignedTms": {
      "1": {
        "priority": 1
      }
    },
    "assignedGlossaries": [
      2
    ],
    "assignedStyleGuides": [
      2
    ],
    "tmPenalties": {
      "autoSubstitution": 1,
      "tmPriority": {
        "priority": 2,
        "penalty": 1
      },
      "multipleTranslations": 1,
      "timeSinceLastUsage": {
        "months": 2,
        "penalty": 1
      },
      "timeSinceLastModified": {
        "months": 2,
        "penalty": 1
      }
    },
    "tmPreTranslate": {
      "enabled": true,
      "autoApproveOption": "all",
      "minimumMatchRatio": "perfect"
    },
    "mtPreTranslate": {
      "enabled": true,
      "mts": [
        {
          "mtId": 1,
          "languageIds": [
            "uk"
          ]
        }
      ]
    },
    "aiPreTranslate": {
      "enabled": true,
      "aiPrompts": [
        {
          "aiPromptId": 1,
          "languageIds": [
            "uk"
          ]
        }
      ]
    },
    "preTranslationAiPromptId": 1,
    "editorSuggestionAiPromptId": 2,
    "qaCheckActionAiPromptId": 8,
    "contextReviewAiPromptId": 11,
    "inContext": true,
    "inContextProcessHiddenStrings": true,
    "inContextPseudoLanguageId": "uk",
    "inContextPseudoLanguage": {
      "id": "uk",
      "name": "Ukrainian",
      "editorCode": "uk",
      "twoLettersCode": "uk",
      "threeLettersCode": "ukr",
      "locale": "uk-UA",
      "androidCode": "uk-rUA",
      "osxCode": "uk.lproj",
      "osxLocale": "uk",
      "pluralCategoryNames": [
        "one",
        "few",
        "many",
        "other"
      ],
      "pluralRules": "((n%10==1 && n%100!=11) ? 0 : ((n%10 >= 2 && n%10 <=4 && (n%100 < 12 || n%100 > 14)) ? 1 : ((n%10 == 0 || (n%10 >= 5 && n%10 <=9)) || (n%100 >= 11 && n%100 <= 14)) ? 2 : 3))",
      "pluralExamples": [
        "1, 21, 31, 41, 51, 61, 71, 81...",
        "2-4, 22-24, 32-34, 42-44, 52-54, 62...",
        "0, 5-19, 100, 1000, 10000...",
        "0.0-0.9, 1.1-1.6, 10.0, 100.0..."
      ],
      "textDirection": "ltr"
    }
  }
}

Changes

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