Skip to main content
API reference sections

Schema

LanguageChoice

A language preference: automatic, or one BCP 47 tag.

The authority validates the shape of a tag and never resolves it: the closed set of languages lives with each consumer (koru-i18n for the UI, the speech engine for dictation, the spell engine for spelling), and pinning a copy of any of them here would be a second list to keep true. An unrecognized tag resolves to automatic at the consumer.

Grew out of the dictation preference when spell checking needed exactly the same shape; [DictationLanguage] remains as an alias so nothing renames on the wire or at a call site.

Type "automatic" or object

Shape

One of 2 shapes:

  1. Variant 1

    "automatic"

  2. Variant 2

    FieldTypeDescription
    tagrequiredstring
Example
"automatic"

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.