API Reference

Create a Score-Generator instance in a configuration

post
https://api.embermind.ch/api/v1/client/score-generators/create

Create a new score generator instance. BASIC types may be added multiple times (multi-instance: different windows / thresholds / points); MAIN provider checks and boolean BASIC comparisons are single-instance and rejected if one already exists in the configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

Scoring configuration to add the generator to

string
enum
required

Score generator type

integer
≥ 0

Points added when the rule triggers (must be >= 0; defaults to the system default)

string
enum

Behavior when required input is missing (defaults to NO_SCORE)

Allowed:
boolean

Whether the new instance is active (defaults to true)

integer
≥ 0

Threshold count (only for count-based types; defaults to the system default)

integer
0 to 100

Threshold percentage (only for ERROR_RATE; defaults to the system default)

string
enum

Time window in seconds. Must be one of the allowed presets (windowed types only).

errorReasonList
array of strings

Gate error reasons that trigger this score generator (MAIN generators only). Empty list means all error reasons are accepted. A non-empty list on a BASIC type is rejected — for BASIC error-rate use a custom RATE rule with an errorReason filter.

errorReasonList
Headers
string
string
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?