CRcrowdin
Style Guides

Create Style Guide

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

post/style-guides

Request

Request body

namestring required

Style Guide name

aiInstructionsstring nullable

Style Guide instructions for 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 style guide should be shared to all projects within the account

storageIdinteger nullable required

Storage identifier.

Example request

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

Response

Style Guide was successfully created

Example response

{
  "data": {
    "id": 2,
    "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://crowdin.com/profile/{userName}/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",
    "managerIds": [
      13240049
    ]
  }
}

Changes

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