Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Slot Fillers

Create a Slot Filler

Creates a Slot Filler in the Project.

post/v2.0/flows/{flowId}/slotfillers

Path parameters

flowIdstring required

The unique identifier for the Flow.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

namestring

The display name of the Slot Filler.

type'age' | 'date' | 'duration' | 'email' | 'intent' | 'slot' | 'money' | 'number' | 'percentage' | 'regex' | 'temperature'

The type of the Slot Filler.

usePositiveOnlyboolean

If set to true, extracts only Slots from predefined Keyphrases.

storeResultInContextboolean

If set to true, stores the result in the Context object.

contextKeystring

The key used to store the result in the Context object.

storeInContactProfileboolean

If set to true, the result is stored in the Contact Profile.

profileKeystring

The key used to store the result in the Contact Profile.

storeDetailedResultsboolean

If set to true, stores metadata about the extracted Slot.

skipIfResultInContextboolean

If set to true, the user input isn't checked for the Slot that is already in the Context object.

additionalValidationstring

The additional validation expression or script.

resultLocationstring

Determines where to extract the Slot value from. By default, the Slot value is extracted from the user input. You can set a CognigyScript expression in this parameter to override the detected Slot value with a value from the Input, Context, or Profile objects. This parameter works only if the user input is recognized and the CognigyScript expression doesn't resolve to a falsy value.

regexstring

The regex pattern to extract specific data from the user input. Used only when the Slot Filler type is regex.

slotstring

Specifies which Slot this Filler is associated with, for example, date or airport_code. Used only when the Slot Filler type is slot.

Example request

{
  "type": "age"
}

Response

Returns SlotFiller metadata object.

namestring

The display name of the Slot Filler.

type'age' | 'date' | 'duration' | 'email' | 'intent' | 'slot' | 'money' | 'number' | 'percentage' | 'regex' | 'temperature'

The type of the Slot Filler.

usePositiveOnlyboolean

If set to true, extracts only Slots from predefined Keyphrases.

storeResultInContextboolean

If set to true, stores the result in the Context object.

contextKeystring

The key used to store the result in the Context object.

storeInContactProfileboolean

If set to true, the result is stored in the Contact Profile.

profileKeystring

The key used to store the result in the Contact Profile.

storeDetailedResultsboolean

If set to true, stores metadata about the extracted Slot.

skipIfResultInContextboolean

If set to true, the user input isn't checked for the Slot that is already in the Context object.

additionalValidationstring

The additional validation expression or script.

resultLocationstring

Determines where to extract the Slot value from. By default, the Slot value is extracted from the user input. You can set a CognigyScript expression in this parameter to override the detected Slot value with a value from the Input, Context, or Profile objects. This parameter works only if the user input is recognized and the CognigyScript expression doesn't resolve to a falsy value.

regexstring

The regex pattern to extract specific data from the user input. Used only when the Slot Filler type is regex.

slotstring

Specifies which Slot this Filler is associated with, for example, date or airport_code. Used only when the Slot Filler type is slot.

referenceIdstring uuid
_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "type": "age",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}