CRcrowdin
Style Guides

Create Style Guide

Required scopes: style-guide (Read and Write).

post/style-guides

Request

Request body

namestring required

Style Guide name

groupIdinteger nullable

Group Identifier - defines group to which Style Guide is added. If omitted, root group is used.

aiInstructionsstring nullable

Rules to be used by AI models

Note: maxLength counts bytes, not characters — a non-Latin value reaches the limit two to four times sooner than its character count suggests

languageIdsstring[]

Style Guide Language Identifier list. Get via List Supported Languages

projectIdsinteger[]

Project ids to assign style guide to

isSharedboolean

Whether the style guide should be shared across all projects within the group

storageIdinteger nullable required

Storage identifier.

Example request

{
  "name": "Be My Eyes iOS's Style Guide",
  "groupId": 2,
  "languageIds": [
    "uk",
    "fr",
    "de"
  ],
  "projectIds": [
    1,
    2,
    3
  ],
  "storageId": 1
}

Response

Style Guide was successfully created

Example response

{
  "data": {
    "id": 2,
    "groupId": 5,
    "name": "Be My Eyes iOS's Style Guide",
    "aiInstructions": "Rules to be used by AI models",
    "userId": 2,
    "languageIds": [
      "uk",
      "fr",
      "de"
    ],
    "projectIds": [
      6
    ],
    "webUrl": "https://example.crowdin.com/u/style-guides?id=1",
    "downloadLink": "https://storage.crowdin.com/style-guide/123/456/file.pdf",
    "createdAt": "2019-09-16T13:42:04+00:00",
    "updatedAt": "2019-09-16T13:42:04+00:00"
  }
}

Changes

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