The active community configuration

GET

/api/v1/config

curl --request GET \
  --url https://example.com/api/v1/config

Option sets, bands, rules and tone settings. Nothing in it is secret.

Responses

200

Successful Response

Media typeapplication/json

CommunityConfig

Validated community configuration; version is the sha256 of the canonical YAML.

object

bands

required

Bands

Provisional sharpness-band thresholds.

object

confident_min

required

Confident Min

number

> 0 <= 1

order_sensitivity_max

Order Sensitivity Max

number

default: 0.3

unsure_min

required

Unsure Min

number

> 0 <= 1

calibration

Any of:

CalibrationRef

CalibrationRef

The calibration whose thresholds are folded into this configuration, if any.

object

id

required

Id

string

>= 1 characters <= 64 characters

null

null

id

required

Id

string

option_sets

required

OptionSets

Option sets for Q1 (nature) and Q2 (response).

object

nature

required

Nature

Array<object>

Option

One answer option of a Decider question, with UI/criteria text.

object

code

required

Code

string

description

required

Description

string

label

required

Label

string

response

required

Response

Array<object>

Option

One answer option of a Decider question, with UI/criteria text.

object

code

required

Code

string

description

required

Description

string

label

required

Label

string

pack

Any of:

PackInfo

PackInfo

Who a pack is for and who wrote it; shown in the pack list. Not used by the decision code.

object

author

required

Author

string

>= 1 characters <= 80 characters

description

required

Description

string

>= 1 characters <= 400 characters

id

required

Id

string

/^[a-z0-9][a-z0-9-]{0,39}$/

title

required

Title

string

>= 1 characters <= 80 characters

version

required

Version

string

>= 1 characters <= 20 characters

null

null

panel

required

Panel

Fact panel: the yes/no probe ids asked of the Decider and the tri-state thresholds.

object

band

PanelBand

Backend band from how many composed probes read unknown (cautious reading).

object

confident_max_unknown

Confident Max Unknown

integer

default: 1

unsure_max_unknown

Unsure Max Unknown

integer

default: 3

composition

CompositionOptions

Options of the composition tables a community may switch (both off by default).

They never touch the rules or the parsed-fact floor: they only change which table row a given set of readings lands on.

object

newcomer_welcome_over_question

Newcomer Welcome Over Question

boolean

p4_requires_both

P4 Requires Both

boolean

noul_ids

required

Noul Ids

Array<string>

probe_thresholds

Probe Thresholds

object

key

additional properties

PanelThresholds

Tri-state cut points for panel probabilities: below low no, above high yes.

object

high

required

High

number

> 0 < 1

low

required

Low

number

> 0 < 1

thresholds

required

PanelThresholds

Tri-state cut points for panel probabilities: below low no, above high yes.

object

high

required

High

number

> 0 < 1

low

required

Low

number

> 0 < 1

rules

required

Rules

Array<object>

RuleConfig

Parameters of one deterministic policy rule.

object

code

required

Code

string

label

required

Label

string

params

Params

object

key

additional properties

any

tone

required

Tone

Drafting tone constraints.

object

allowed_links

required

Allowed Links

Array<string>

banned_words

required

Banned Words

Array<string>

language_policy

required

Language Policy

string

version

required

Version

string

Example

{
  "bands": {
    "order_sensitivity_max": 0.3
  },
  "panel": {
    "band": {
      "confident_max_unknown": 1,
      "unsure_max_unknown": 3
    },
    "composition": {
      "newcomer_welcome_over_question": false,
      "p4_requires_both": false
    }
  }
}