Skip to content

Get vocabulary settings

The organization's vocabulary settings. Every member who manages a private vocabulary may read them; editable says whether the caller may change them.

GEThttps://api.aitronos.com/v1/vocabulary/settings

Returns

The vocabulary settings:

learn_from_corrections boolean

Whether a person's corrections teach their own private vocabulary.

learned_sharing_mode string

How words several colleagues taught reach the shared list: approval (an administrator approves each) or automatic.

share_threshold integer

How many colleagues must have taught a word before it is proposed for the shared list.

shared_target_list_id string

The list shared words go to; the organization list unless another list was chosen.

suggestions_enabled boolean

Whether suggestions are collected.

automatic_state string

off in approval mode; active, or paused when automatic sharing stopped by itself.

automatic_paused_reason string or null

Why automatic sharing is paused, when it is.

revision integer

The settings revision; send it back as expected_revision.

editable boolean

Whether the caller may change the settings.

cURL
curl -X GET "https://api.aitronos.com/v1/vocabulary/settings" \
  -H "X-API-Key: $FREDDY_API_KEY"

Response:

200 OK
{
  "learn_from_corrections": true,
  "learned_sharing_mode": "approval",
  "share_threshold": 3,
  "shared_target_list_id": "voclist_1b7d5e9f3a2c4680",
  "suggestions_enabled": true,
  "automatic_state": "off",
  "automatic_paused_reason": null,
  "revision": 4,
  "editable": false
}