Tags API

Tags are added to stories as a way to categorize them. Each tag consists of a display name, slug, and description. Tags are not denormalized in documents on the Content API; however, the base display name and slug are available on each document.

Language support in tags

The three components of Tags (display name, slug, and description) each have their own language capabilities:

• Name
  The display name of the tag to help the user choose the correct tag. The display name can be in any supported content creation language, for example, English, Korean, Arabic.
• Slug
  The name of the tag used in URLs. You must encode all URL data in UTF-8. You can create a slug in the UI or through the API: ** In the Tags UI, a tag name in a non-Latin character set (for example, Cyrillic, Arabic, Chinese) will be transliterated by the tool into Latin characters. For example, the Tags UI would transliterate مرحبا بك في عالم البرمجة into marhaba bk fy ealim albramajah. This isn’t translating the text into a Latin language. Instead, it’s using Latin characters that make the URL more compatible with a range of systems. ** In the Tags API, you must create a slug with Latin characters. Non-Latin characters are not supported. If you enter non-Latin characters, you receive the following error message:

{
    "StatusCode": 400,
    "Payload": {
        "message": "slug must contain only letters, numbers, and hyphens."
    }
}

• Description
  A long description of the tag to help user choose the correct tag. The description can be in any supported content creation language, for example, English, Korean, Arabic.

Note: You can search for tags using only the slug. Therefore, take note of the slugified (transliterated) value of the slug when creating tags in non-Latin characters. For example, the system transliterates the slug name الأم to l-m, and you can find this slug by searching for only l-m as the keyword.