Skip to main content

Create project

POST 

/v2/projects

Creates a new project with languages and initial settings.

Request

Body

required
    name stringrequired

    Possible values: >= 3 characters and <= 50 characters

    languages object[]required
  • Array [
  • name stringrequired

    Possible values: <= 100 characters

    Language name in english

    originalName stringrequired

    Possible values: <= 100 characters

    Language name in this language

    tag stringrequired

    Possible values: <= 20 characters, Value must match regular expression ^[^,]*$

    Language tag according to BCP 47 definition

    flagEmoji string

    Possible values: <= 20 characters

    Language flag emoji as UTF-8 emoji

  • ]
  • slug string

    Possible values: >= 3 characters and <= 60 characters, Value must match regular expression ^[a-z0-9-]*[a-z]+[a-z0-9-]*$

    Slug of your project used in url e.g. "/v2/projects/what-a-project". If not provided, it will be generated

    organizationId int64required

    Possible values: >= 1

    Organization to create the project in

    baseLanguageTag string

    Tag of one of created languages, to select it as base language. If not provided, first language will be selected as base.

    icuPlaceholders booleanrequired

    Whether to use ICU placeholder visualization in the editor and it's support.

Responses

OK

Schema
    id int64required
    name stringrequired
    description string
    slug string
    avatar object
    large stringrequired
    thumbnail stringrequired
    organizationOwner object
    id int64required
    name stringrequired
    slug stringrequired
    description string
    basePermissions objectrequired

    Current user's direct permission

    scopes string[]required

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    translateLanguageIds int64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    stateChangeLanguageIds int64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    avatar object
    large stringrequired
    thumbnail stringrequired
    baseLanguage object
    id int64required
    name stringrequired

    Language name in english

    tag stringrequired

    Language tag according to BCP 47 definition

    originalName string

    Language name in this language

    flagEmoji string

    Language flag emoji as UTF-8 emoji

    base booleanrequired

    Whether is base language of project

    defaultNamespace object
    id int64required

    The id of namespace

    name stringrequired
    organizationRole string

    Possible values: [MEMBER, OWNER]

    directPermission object

    Current user's direct permission

    scopes string[]required

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    translateLanguageIds int64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    stateChangeLanguageIds int64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    computedPermission objectrequired
    permissionModel object

    Current user's direct permission

    scopes string[]required

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    translateLanguageIds int64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    stateChangeLanguageIds int64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    origin stringrequired

    Possible values: [ORGANIZATION_BASE, DIRECT, ORGANIZATION_OWNER, NONE, SERVER_ADMIN]

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    viewLanguageIds int64[]

    List of languages user can view. If null, all languages view is permitted.

    translateLanguageIds int64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    stateChangeLanguageIds int64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    scopes string[]required

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage]

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    type string

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    The user's permission type. This field is null if uses granular permissions

    icuPlaceholders booleanrequired

    Whether to disable ICU placeholder visualization in the editor and it's support.

Loading...