Skip to content

Update Settings

PUT
/api/divinity/authored-library/settings

Persist updated settings. Flips the service’s kill switch in-process.

AuthoredLibraryConfig

Persisted Authored Library configuration.

Lives nested under the divinity_engine section of :class:backend.core.config.config.IshvanaConfig. Every field has a documented default so a fresh install works without user setup.

object
enabled
Enabled

Master kill switch. When False, every consumer receives raw handler messages (pre-M6 behaviour). Flip to False only for debugging or if a bundled pack ships with a fatal defect.

boolean
default: true
selectionAlgorithm
Selectionalgorithm

Which algorithm picks a variant from the filtered pool. Hash-deterministic is the reproducible default; round-robin cycles per session; weighted-random + seed is reproducible variety; user-preference hard-filters by tag allowlist.

string
default: hash_deterministic
Allowed values: hash_deterministic round_robin weighted_random user_preference
tonePreference
Tonepreference

Soft bias toward variants carrying this tone tag. ‘balanced’ applies no bias.

string
default: balanced
Allowed values: constructive analytical urgent warm direct balanced
tagAllowlist
Tagallowlist

Hard filter — when non-empty, only variants whose tag set intersects the allowlist survive. Empty = accept every tag.

Array<string>
seed
Any of:
integer
packSources
Packsources

Absolute paths of enabled community packs. Managed by the import/export routes; users can toggle per-pack from the UI.

Array<string>
preferredGenre
Any of:
string

Successful Response

AuthoredLibraryConfig

Persisted Authored Library configuration.

Lives nested under the divinity_engine section of :class:backend.core.config.config.IshvanaConfig. Every field has a documented default so a fresh install works without user setup.

object
enabled
Enabled

Master kill switch. When False, every consumer receives raw handler messages (pre-M6 behaviour). Flip to False only for debugging or if a bundled pack ships with a fatal defect.

boolean
default: true
selectionAlgorithm
Selectionalgorithm

Which algorithm picks a variant from the filtered pool. Hash-deterministic is the reproducible default; round-robin cycles per session; weighted-random + seed is reproducible variety; user-preference hard-filters by tag allowlist.

string
default: hash_deterministic
Allowed values: hash_deterministic round_robin weighted_random user_preference
tonePreference
Tonepreference

Soft bias toward variants carrying this tone tag. ‘balanced’ applies no bias.

string
default: balanced
Allowed values: constructive analytical urgent warm direct balanced
tagAllowlist
Tagallowlist

Hard filter — when non-empty, only variants whose tag set intersects the allowlist survive. Empty = accept every tag.

Array<string>
seed
Any of:
integer
packSources
Packsources

Absolute paths of enabled community packs. Managed by the import/export routes; users can toggle per-pack from the UI.

Array<string>
preferredGenre
Any of:
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object