Skip to main content

Create project

POST 

/v2/projects

Creates a new project with languages and initial settings.

Request

Body

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

    languages object[]required
  • Array [
  • flagEmoji string

    Possible values: <= 20 characters

    Language flag emoji as UTF-8 emoji

    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

  • ]
  • name stringrequired

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

    organizationId int64required

    Possible values: >= 1

    Organization to create the project in

    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

Responses

OK

Schema
    avatar object
    large stringrequired
    thumbnail stringrequired
    baseLanguage object
    base booleanrequired

    Whether is base language of project

    flagEmoji string

    Language flag emoji as UTF-8 emoji

    id int64required
    name stringrequired

    Language name in english

    originalName string

    Language name in this language

    tag stringrequired

    Language tag according to BCP 47 definition

    computedPermission objectrequired
    origin stringrequired

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

    permissionModel object

    Current user's direct permission

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

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

    stateChangeLanguageIds int64[]

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

    translateLanguageIds int64[]

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

    type string

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

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

    viewLanguageIds int64[]

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

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

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

    stateChangeLanguageIds int64[]

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

    translateLanguageIds int64[]

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

    type string

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

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

    viewLanguageIds int64[]

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

    defaultNamespace object
    id int64required

    The id of namespace

    name stringrequired
    description string
    directPermission object

    Current user's direct permission

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

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

    stateChangeLanguageIds int64[]

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

    translateLanguageIds int64[]

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

    type string

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

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

    viewLanguageIds int64[]

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

    icuPlaceholders booleanrequired

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

    id int64required
    name stringrequired
    organizationOwner object
    avatar object
    large stringrequired
    thumbnail stringrequired
    basePermissions objectrequired

    Current user's direct permission

    permittedLanguageIds int64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition 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, tasks.view, tasks.edit]

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

    stateChangeLanguageIds int64[]

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

    translateLanguageIds int64[]

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

    type string

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

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

    viewLanguageIds int64[]

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

    description string
    id int64required
    name stringrequired
    slug stringrequired
    organizationRole string

    Possible values: [MEMBER, OWNER]

    slug string
    useNamespaces booleanrequired
Loading...