---
title: "Set parameters to the given AI configuration."
method: POST
path: "/v2/config/parameters/{configId}"
tags: ["Detailed configuration parameters"]
---

# Set parameters to the given AI configuration.

`POST /v2/config/parameters/{configId}`

## Request

- Base URL: `https://api.irisnet.de`
- URL: `https://api.irisnet.de/v2/config/parameters/{configId}`
- Auth: API key in header `LICENSE-KEY`

Save or modify the parameters stored in the AI configuration.

## Path parameters

- `configId` string, uuid, required

## Request body

- ParamSet: A set of parameters/rules that describe how the AI should behave.
  - `thresh` number, float: Threshold when an object can be recognized. Lowering the value will increase the probability of recognizing objects. A threshold of 0.5 would mean, that 50% of an object like a face must be visible, to be detected.Setting the value too low however, can cause false positives.
  - `grey` integer: A grey scale color to use for frame or masking. '0' will represent black, while the maximum '255' will be white.
  - `minDuration` integer: Set the overall minimum duration in milliseconds for a rule to be broken in moving images.
  - `abortOnSeverity` integer: Set a severity on which to automatically stop the check operation. Works with moving images.Use '-1' to ignore this option.
  - `params` Param[]: A list of parameter sets that describe the rules of the objects.
    - `classification` 'nudityCheck' | 'face' | 'hand' | 'foot' | 'footwear' | 'chest' | 'breast' | 'vulva' | 'penis' | 'vagina' | 'buttocks' | 'anus' | 'oral' | 'penetration' | 'toy' | 'bondage' | 'gag' | 'ageEstimation' | 'child' | 'adult' | 'senior' | 'pose' | 'illegalSymbols' | 'textRecognition' | 'attributesCheck' | 'female' | 'male' | 'hair' | 'hairless' | 'beard' | 'moustache' | 'headpiece' | 'glasses' | 'sunglasses' | 'mask' | 'slimSizedFace' | 'realSizedFace' | 'plusSizedFace' | 'bodyAttributes' | 'slimSized' | 'realSized' | 'plusSized' | 'nippleCheck' | 'noNipple' | 'hasNipple' | 'unwantedSubstances' | 'beer' | 'beerBottle' | 'beerCan' | 'wine' | 'wineBottle' | 'cocktail' | 'alcohol' | 'cannabis' | 'cigarette' | 'cocaine' | 'heroine' | 'coffee' | 'violenceCheck' | 'camouflage' | 'club' | 'knife' | 'sword' | 'pistol' | 'rifle' | 'cannon' | 'fire' | 'selfieCheck' | 'hand2mouth' | 'point2nose' | 'relaxed' | 'point2chin' | 'hand2cheek' | 'excellent' | 'nice' | 'thinking' | 'thumbUp' | 'victory' | 'lookout' | 'fingerUp' | 'middleFinger' | 'celebrityCheck' | 'celebrity' | 'advancedTextRecognition' | 'text' | 'textModeration' | 'phoneNumber' | 'socialHandle' | 'email' | 'website' | 'badWord', required: The classification of the object, that the element refers to. The following is a tree representation of the prototypes and their containing classifications. Default parameter values are defined per classification object. The default values of 'min', 'max' and 'drawMode' are witten after the name of the classification object in that order. Use the prototype names to set parameters to all of the containing classifications. ##### nudityCheck > _A prototype containing classifications for basic human attributes and sexual contents. This prototype and the containing classifications are activated by default._ * _face_ _(1, 3, 0)_ * _hand_ _(0, -1, 0)_ * _foot_ _(0, -1, 0)_ * _footwear_ _(0, -1, 0)_ * _chest_ _(0, -1, 0)_ * _breast_ _(0, 0, 2)_ * _vulva_ _(0, 0, 2)_ * _penis_ _(0, 0, 2)_ * _vagina_ _(0, 0, 2)_ * _buttocks_ _(0, 0, 2)_ * _anus_ _(0, 0, 2)_ * _oral_ _(0, 0, 2)_ * _penetration_ _(0, 0, 2)_ * _toy_ _(0, -1, 0)_ * _bondage_ _(0, -1, 0)_ * _gag_ _(0, -1, 0)_ ##### ageEstimation > _Contains classification objects for estimating the age of a human face. This prototype activates nudityCheck._ * _child (*)_ _(0, 0, 6)_ * _adult (*)_ _(0, -1, 0)_ * _senior (*)_ _(0, -1, 0)_ * _pose (*)_ _(0, 0, 0)_ - The age can not be estimated, due to a pose that hides facial features. ##### illegalSymbols > _Contains various classification objects of symbols that are prohibited in Germany (e.g. Hakenkreuz, SS, etc). These are grouped under a single name._ * _illegalSymbols_ _(0, 0, 1)_ ##### textRecognition > _Contains letters, numbers and some symbols (e.g. @, #, etc) as classification objects. These are grouped under a single name._ * _textRecognition_ _(0, 6, 6)_ ##### attributesCheck > _Contains classification objects for various attributes of the human face. This prototype activates nudityCheck._ * _female_ _(0, -1, 0)_ * _male_ _(0, -1, 0)_ * _hair_ _(0, -1, 0)_ * _hairless_ _(0, -1, 0)_ * _beard_ _(0, -1, 0)_ * _moustache_ _(0, -1, 0)_ * _headpiece_ _(0, -1, 0)_ * _glasses_ _(0, -1, 0)_ * _sunglasses_ _(0, -1, 0)_ * _mask_ _(0, -1, 0)_ * _slimSizedFace (*)_ _(0, -1, 0)_ * _realSizedFace (*)_ _(0, -1, 0)_ * _plusSizedFace (*)_ _(0, -1, 0)_ ##### bodyAttributes > _Contains classification objects for determining the body size._ * _slimSized_ _(0, -1, 0)_ * _realSized_ _(0, -1, 0)_ * _plusSized_ _(0, -1, 0)_ ##### nippleCheck > _Contains classifications for determining if the object recognized as breast has a nipple. This prototype activates nudityCheck_ * _noNipple_ _(0, -1, 0)_ * _hasNipple_ _(0, 0, 0)_ ##### unwantedSubstances > _Contains classification objects for different substances._ * _beer_ _(0, -1, 0)_ * _beerBottle_ _(0, -1, 0)_ * _beerCan_ _(0, -1, 0)_ * _wine_ _(0, -1, 0)_ * _wineBottle_ _(0, -1, 0)_ * _cocktail_ _(0, -1, 0)_ * _alcohol_ _(0, -1, 0)_ * _cannabis_ _(0, 0, 0)_ * _cigarette_ _(0, 0, 0)_ * _cocaine_ _(0, 0, 0)_ * _heroine_ _(0, 0, 0)_ * _coffee_ _(0, -1, 0)_ ##### violenceCheck > _Contains classification objects for violent items or acts._ * _camouflage_ _(0, -1, 0)_ * _club_ _(0, -1, 0)_ * _knife_ _(0, 0, 0)_ * _sword_ _(0, 0, 0)_ * _pistol_ _(0, 0, 0)_ * _rifle_ _(0, 0, 0)_ * _cannon_ _(0, 0, 0)_ * _fire_ _(0, -1, 0)_ ##### selfieCheck > _Classification objects representing various pre-defined poses for the selfie task._ * _hand2mouth_ _(0, 1, 0)_ * _point2nose_ _(0, 1, 0)_ * _relaxed_ _(0, 1, 0)_ * _point2chin_ _(0, 1, 0)_ * _hand2cheek_ _(0, 1, 0)_ * _excellent_ _(0, 1, 0)_ * _nice_ _(0, 1, 0)_ * _thinking_ _(0, 1, 0)_ * _thumbUp_ _(0, 1, 0)_ * _victory_ _(0, 1, 0)_ * _lookout_ _(0, 1, 0)_ * _fingerUp_ _(0, 1, 0)_ * _middleFinger_ _(0, 0, 0)_ ##### celebrityCheck > _Detects and identifies popular celebrities in the image. This prototype activates nudityCheck._ * _celebrity_ _(0, 0, 0)_ ##### advancedTextRecognition > _Performs advanced text extraction with contextual analysis._ * _text_ _(0, 0, 0)_ ##### imageCategorization ##### textModeration > _Identifies phone numbers, social media handles, emails, websites, and offensive words for moderation purposes._ * _phoneNumber_ _(0, 0, 0)_ * _socialHandle_ _(0, 0, 0)_ * _email_ _(0, 0, 0)_ * _website_ _(0, 0, 0)_ * _badWord_ _(0, 0, 0)_ ##### languageDetection _Classification objects that are marked with (*) are sub-classifications of face. Both face and the marked classification are affected by the given parameter values._ _Please be aware that the default values can be subject to change. This is due to the difficulty of recognizing certain objects e.g. objects that are classified as toy._
    - `prototype` string: The prototype that the classification object belongs to. Setting the prototype will specify the parameters for the classification belonging to the prototype.
    - `min` integer: The minimum amount of objects allowed on the image. Setting the value to -1 will cause the AI to ignore this rule. For moving images this value is applied to a single frame.
    - `max` integer: The maximum amount of objects allowed on the image. Setting the value to -1 will cause the AI to ignore this rule. For moving images this value is applied to a single frame.
    - `severity` integer: Set a value to define the severity of a broken rule of the given classification object.
    - `drawMode` integer: Set if and how a classification object should be drawn over. * _0_ - will draw nothing, * _1_ - will draw a frame with class name surrounding the object, * _2_ - will draw a filled rectangle that will mask the object, * _3_ - is a combination between _1_ and _2_ (frame/name + mask), * _6_ - will blur the object and * _7_ - is a combination between _1_ and _6_ (frame/name + blur).
    - `grey` integer: A grey scale color used in combination of _drawMode_ '2' or '3'. '0' will represent black, while the maximum '255' will be white.
    - `scale` number, float: Scale of the bounds around the classification object. Specify a value to increase or decrease the size of the bounds. This is applied to the resulting media as well as the JSON coordinates.
    - `ignore` boolean: A shorthand to ignore the classification object. This is equal to setting _min=0_, _max=-1_ and _drawMode=0_.
  - `kycUiParameters` KycUiParameter: A collection of parameters that determine the appearance and behaviour of the user interface (UI).
    - `primaryColor` string: The primary color of the UI in hex format (rrggbb).
    - `backgroundColor` string: The background color of the UI in hex format (rrggbb).
    - `textColor` string: The text color of the UI in hex format (rrggbb).
    - `logo` string: The company logo for the UI in PNG fileformat (512 px * 512 px) as a base64 encoded string.
    - `logoBackgroundColor` string: The logo background color in hex format (rrggbb).
    - `language` string: The language related settings for the UI as a JSON.

## Response `200`

successful operation. Previous user configured parameters are returned.

- ParamSet: A set of parameters/rules that describe how the AI should behave.
  - `thresh` number, float: Threshold when an object can be recognized. Lowering the value will increase the probability of recognizing objects. A threshold of 0.5 would mean, that 50% of an object like a face must be visible, to be detected.Setting the value too low however, can cause false positives.
  - `grey` integer: A grey scale color to use for frame or masking. '0' will represent black, while the maximum '255' will be white.
  - `minDuration` integer: Set the overall minimum duration in milliseconds for a rule to be broken in moving images.
  - `abortOnSeverity` integer: Set a severity on which to automatically stop the check operation. Works with moving images.Use '-1' to ignore this option.
  - `params` Param[]: A list of parameter sets that describe the rules of the objects.
    - `classification` 'nudityCheck' | 'face' | 'hand' | 'foot' | 'footwear' | 'chest' | 'breast' | 'vulva' | 'penis' | 'vagina' | 'buttocks' | 'anus' | 'oral' | 'penetration' | 'toy' | 'bondage' | 'gag' | 'ageEstimation' | 'child' | 'adult' | 'senior' | 'pose' | 'illegalSymbols' | 'textRecognition' | 'attributesCheck' | 'female' | 'male' | 'hair' | 'hairless' | 'beard' | 'moustache' | 'headpiece' | 'glasses' | 'sunglasses' | 'mask' | 'slimSizedFace' | 'realSizedFace' | 'plusSizedFace' | 'bodyAttributes' | 'slimSized' | 'realSized' | 'plusSized' | 'nippleCheck' | 'noNipple' | 'hasNipple' | 'unwantedSubstances' | 'beer' | 'beerBottle' | 'beerCan' | 'wine' | 'wineBottle' | 'cocktail' | 'alcohol' | 'cannabis' | 'cigarette' | 'cocaine' | 'heroine' | 'coffee' | 'violenceCheck' | 'camouflage' | 'club' | 'knife' | 'sword' | 'pistol' | 'rifle' | 'cannon' | 'fire' | 'selfieCheck' | 'hand2mouth' | 'point2nose' | 'relaxed' | 'point2chin' | 'hand2cheek' | 'excellent' | 'nice' | 'thinking' | 'thumbUp' | 'victory' | 'lookout' | 'fingerUp' | 'middleFinger' | 'celebrityCheck' | 'celebrity' | 'advancedTextRecognition' | 'text' | 'textModeration' | 'phoneNumber' | 'socialHandle' | 'email' | 'website' | 'badWord', required: The classification of the object, that the element refers to. The following is a tree representation of the prototypes and their containing classifications. Default parameter values are defined per classification object. The default values of 'min', 'max' and 'drawMode' are witten after the name of the classification object in that order. Use the prototype names to set parameters to all of the containing classifications. ##### nudityCheck > _A prototype containing classifications for basic human attributes and sexual contents. This prototype and the containing classifications are activated by default._ * _face_ _(1, 3, 0)_ * _hand_ _(0, -1, 0)_ * _foot_ _(0, -1, 0)_ * _footwear_ _(0, -1, 0)_ * _chest_ _(0, -1, 0)_ * _breast_ _(0, 0, 2)_ * _vulva_ _(0, 0, 2)_ * _penis_ _(0, 0, 2)_ * _vagina_ _(0, 0, 2)_ * _buttocks_ _(0, 0, 2)_ * _anus_ _(0, 0, 2)_ * _oral_ _(0, 0, 2)_ * _penetration_ _(0, 0, 2)_ * _toy_ _(0, -1, 0)_ * _bondage_ _(0, -1, 0)_ * _gag_ _(0, -1, 0)_ ##### ageEstimation > _Contains classification objects for estimating the age of a human face. This prototype activates nudityCheck._ * _child (*)_ _(0, 0, 6)_ * _adult (*)_ _(0, -1, 0)_ * _senior (*)_ _(0, -1, 0)_ * _pose (*)_ _(0, 0, 0)_ - The age can not be estimated, due to a pose that hides facial features. ##### illegalSymbols > _Contains various classification objects of symbols that are prohibited in Germany (e.g. Hakenkreuz, SS, etc). These are grouped under a single name._ * _illegalSymbols_ _(0, 0, 1)_ ##### textRecognition > _Contains letters, numbers and some symbols (e.g. @, #, etc) as classification objects. These are grouped under a single name._ * _textRecognition_ _(0, 6, 6)_ ##### attributesCheck > _Contains classification objects for various attributes of the human face. This prototype activates nudityCheck._ * _female_ _(0, -1, 0)_ * _male_ _(0, -1, 0)_ * _hair_ _(0, -1, 0)_ * _hairless_ _(0, -1, 0)_ * _beard_ _(0, -1, 0)_ * _moustache_ _(0, -1, 0)_ * _headpiece_ _(0, -1, 0)_ * _glasses_ _(0, -1, 0)_ * _sunglasses_ _(0, -1, 0)_ * _mask_ _(0, -1, 0)_ * _slimSizedFace (*)_ _(0, -1, 0)_ * _realSizedFace (*)_ _(0, -1, 0)_ * _plusSizedFace (*)_ _(0, -1, 0)_ ##### bodyAttributes > _Contains classification objects for determining the body size._ * _slimSized_ _(0, -1, 0)_ * _realSized_ _(0, -1, 0)_ * _plusSized_ _(0, -1, 0)_ ##### nippleCheck > _Contains classifications for determining if the object recognized as breast has a nipple. This prototype activates nudityCheck_ * _noNipple_ _(0, -1, 0)_ * _hasNipple_ _(0, 0, 0)_ ##### unwantedSubstances > _Contains classification objects for different substances._ * _beer_ _(0, -1, 0)_ * _beerBottle_ _(0, -1, 0)_ * _beerCan_ _(0, -1, 0)_ * _wine_ _(0, -1, 0)_ * _wineBottle_ _(0, -1, 0)_ * _cocktail_ _(0, -1, 0)_ * _alcohol_ _(0, -1, 0)_ * _cannabis_ _(0, 0, 0)_ * _cigarette_ _(0, 0, 0)_ * _cocaine_ _(0, 0, 0)_ * _heroine_ _(0, 0, 0)_ * _coffee_ _(0, -1, 0)_ ##### violenceCheck > _Contains classification objects for violent items or acts._ * _camouflage_ _(0, -1, 0)_ * _club_ _(0, -1, 0)_ * _knife_ _(0, 0, 0)_ * _sword_ _(0, 0, 0)_ * _pistol_ _(0, 0, 0)_ * _rifle_ _(0, 0, 0)_ * _cannon_ _(0, 0, 0)_ * _fire_ _(0, -1, 0)_ ##### selfieCheck > _Classification objects representing various pre-defined poses for the selfie task._ * _hand2mouth_ _(0, 1, 0)_ * _point2nose_ _(0, 1, 0)_ * _relaxed_ _(0, 1, 0)_ * _point2chin_ _(0, 1, 0)_ * _hand2cheek_ _(0, 1, 0)_ * _excellent_ _(0, 1, 0)_ * _nice_ _(0, 1, 0)_ * _thinking_ _(0, 1, 0)_ * _thumbUp_ _(0, 1, 0)_ * _victory_ _(0, 1, 0)_ * _lookout_ _(0, 1, 0)_ * _fingerUp_ _(0, 1, 0)_ * _middleFinger_ _(0, 0, 0)_ ##### celebrityCheck > _Detects and identifies popular celebrities in the image. This prototype activates nudityCheck._ * _celebrity_ _(0, 0, 0)_ ##### advancedTextRecognition > _Performs advanced text extraction with contextual analysis._ * _text_ _(0, 0, 0)_ ##### imageCategorization ##### textModeration > _Identifies phone numbers, social media handles, emails, websites, and offensive words for moderation purposes._ * _phoneNumber_ _(0, 0, 0)_ * _socialHandle_ _(0, 0, 0)_ * _email_ _(0, 0, 0)_ * _website_ _(0, 0, 0)_ * _badWord_ _(0, 0, 0)_ ##### languageDetection _Classification objects that are marked with (*) are sub-classifications of face. Both face and the marked classification are affected by the given parameter values._ _Please be aware that the default values can be subject to change. This is due to the difficulty of recognizing certain objects e.g. objects that are classified as toy._
    - `prototype` string: The prototype that the classification object belongs to. Setting the prototype will specify the parameters for the classification belonging to the prototype.
    - `min` integer: The minimum amount of objects allowed on the image. Setting the value to -1 will cause the AI to ignore this rule. For moving images this value is applied to a single frame.
    - `max` integer: The maximum amount of objects allowed on the image. Setting the value to -1 will cause the AI to ignore this rule. For moving images this value is applied to a single frame.
    - `severity` integer: Set a value to define the severity of a broken rule of the given classification object.
    - `drawMode` integer: Set if and how a classification object should be drawn over. * _0_ - will draw nothing, * _1_ - will draw a frame with class name surrounding the object, * _2_ - will draw a filled rectangle that will mask the object, * _3_ - is a combination between _1_ and _2_ (frame/name + mask), * _6_ - will blur the object and * _7_ - is a combination between _1_ and _6_ (frame/name + blur).
    - `grey` integer: A grey scale color used in combination of _drawMode_ '2' or '3'. '0' will represent black, while the maximum '255' will be white.
    - `scale` number, float: Scale of the bounds around the classification object. Specify a value to increase or decrease the size of the bounds. This is applied to the resulting media as well as the JSON coordinates.
    - `ignore` boolean: A shorthand to ignore the classification object. This is equal to setting _min=0_, _max=-1_ and _drawMode=0_.
  - `kycUiParameters` KycUiParameter: A collection of parameters that determine the appearance and behaviour of the user interface (UI).
    - `primaryColor` string: The primary color of the UI in hex format (rrggbb).
    - `backgroundColor` string: The background color of the UI in hex format (rrggbb).
    - `textColor` string: The text color of the UI in hex format (rrggbb).
    - `logo` string: The company logo for the UI in PNG fileformat (512 px * 512 px) as a base64 encoded string.
    - `logoBackgroundColor` string: The logo background color in hex format (rrggbb).
    - `language` string: The language related settings for the UI as a JSON.

## Other responses

- `204`: successful operation. No previously configured parameters exist.
- `400`: Bad request. Check for badly formatted request body.
- `404`: configId not found.

---

[API](https://skmtc.dev/irisnet/apis/irisnet-api.md) - [All operations](https://skmtc.dev/irisnet/apis/irisnet-api/llms.txt) - [OpenAPI document](https://skmtc.dev/irisnet/apis/irisnet-api/revisions/185759e28101?raw)