Sign in

v1

latestOpenAPI 3.0.32026-07-265278189.1 KB

Create a style rule list

post/v3/style_rules

Request body

namestring required

Name associated with the style rule list.

language'de' | 'en' | 'es' | 'fr' | 'it' | 'ja' | 'ko' | 'zh' required

The language that the style rule list is applied to.

Example request

{
  "configured_rules": {
    "style_and_tone": {
      "abbreviations": "use_abbreviations_and_symbols",
      "short_vs_long_words": "use_short_words"
    },
    "punctuation": {
      "apostrophe": "use_curly_apostrophes"
    }
  }
}

Response

Style rule list created successfully

style_idstring required

A unique ID assigned to a style rule list.

namestring required

Name associated with the style rule list.

creation_timestring date-time required

The creation time of the style rule list in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

updated_timestring date-time required

The time of the style rule list when it was last updated in the ISO 8601-1:2019 format (e.g.: 2022-08-03T14:16:18.329Z).

language'de' | 'en' | 'es' | 'fr' | 'it' | 'ja' | 'ko' | 'zh' required

The language that the style rule list is applied to.

versioninteger required

The version of the style rule list. Incremented when the style rule list is updated.

Example response

{
  "style_id": "bd0a38f3-1831-440b-a8dd-2c702e2325ab",
  "version": 13,
  "configured_rules": {
    "style_and_tone": {
      "abbreviations": "use_abbreviations_and_symbols",
      "short_vs_long_words": "use_short_words"
    },
    "punctuation": {
      "apostrophe": "use_curly_apostrophes"
    }
  },
  "custom_instructions": [
    {
      "id": "68fdb803-c013-4e67-b62e-1aad0ab519cd",
      "label": "Currency custom instruction",
      "prompt": "Have currency symbols before the numerical value (e.g. $100, €100)",
      "source_language": "en"
    }
  ]
}