Tolgee Octri Demo
POST/v2/projects

Create a project

Creates a project with its initial languages and settings in the specified organization. Provide name, organizationId, icuPlaceholders, and at least one language; if you omit baseLanguageTag, the first language is selected as the base language. If you omit slug, one is generated.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Initial project settings and at least one language. The name, organizationId, icuPlaceholders, and languages fields are required.

baseLanguageTagstringoptional
Tag of one of created languages, to select it as base language. If not provided, first language will be selected as base.
icuPlaceholdersbooleanrequired
Whether to use ICU placeholder visualization in the editor and it's support.
languagesarray<object>required
Languages to create with the project. Include at least one language; each item must include `name`, `originalName`, and `tag`. Names must be at most 100 characters, and `tag` must be at most 20 characters and contain no commas.
namestringrequired
Project name. Must be 3–50 characters.
organizationIdintegerrequired
Organization to create the project in
slugstringoptional
Slug of your project used in url e.g. "/v2/projects/what-a-project". If not provided, it will be generated

5 status codes
200Returns the created project object, including its ID, name, slug, language and permission details, and project settings.
avatarobjectoptional
baseLanguageobjectoptional
computedPermissionobjectrequired
defaultNamespaceobjectoptional
descriptionstringoptional
directPermissionobjectoptional
icuPlaceholdersbooleanrequired
Whether to disable ICU placeholder visualization in the editor and it's support.
idintegerrequired
namestringrequired
organizationOwnerobjectoptional
organizationRolestringoptional
Allowed:MEMBEROWNERMAINTAINER
publicbooleanrequired
Whether the project is public — discoverable and open to community suggestions
slugstringoptional
suggestionsModestringrequired
Suggestions for translations
Allowed:DISABLEDENABLED
translationProtectionstringrequired
Level of protection of translations
Allowed:NONEPROTECT_REVIEWED
useBranchingbooleanrequired
useNamespacesbooleanrequired
useQaChecksbooleanrequired
400Returned when the request is malformed, a required field is missing, or a value fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user cannot create a project in the specified organization.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when a referenced resource was not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is malformed or a value fails validation. A 401 indicates that the request is not authenticated, a 403 indicates that the authenticated user cannot create the project, and a 404 indicates that a referenced resource was not found. The body must include name, organizationId, icuPlaceholders, and languages; name must be 3–50 characters, organizationId must be at least 1, and languages must contain at least one item.